GET v1/Lookups/EntityRelations

Get a list of contact relation types, such as Spouse or Child. Use the RelationID as the RelationID when inserting or updating Additional Contacts and Business Contacts

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of relation types

Collection of EntityRelationDTO
NameDescriptionTypeAdditional information
RelationID

Id of the relation. Use this value as the RelationID when inserting or updating additional contacts

integer

None.

Relation

Name of the relation, in the current language

string

None.

RelationCategoryID

Id of the category the relation belongs to

byte

None.

InternalCode

Internal Code

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "RelationID": 1,
    "Relation": "sample string 2",
    "RelationCategoryID": 64,
    "InternalCode": "sample string 4"
  },
  {
    "RelationID": 1,
    "Relation": "sample string 2",
    "RelationCategoryID": 64,
    "InternalCode": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEntityRelationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <EntityRelationDTO>
    <InternalCode>sample string 4</InternalCode>
    <Relation>sample string 2</Relation>
    <RelationCategoryID>64</RelationCategoryID>
    <RelationID>1</RelationID>
  </EntityRelationDTO>
  <EntityRelationDTO>
    <InternalCode>sample string 4</InternalCode>
    <Relation>sample string 2</Relation>
    <RelationCategoryID>64</RelationCategoryID>
    <RelationID>1</RelationID>
  </EntityRelationDTO>
</ArrayOfEntityRelationDTO>