GET Contacts/Relationship

Request Information

URI Parameters

Name	Type	Additional information
EntityRelationshipIDs	Collection of integer	None.
EntityRelationshipIDsToExclude	Collection of integer	None.
BusinessUnits	Collection of integer	None.
BusinessUnitNames	Collection of string	None.
EntityID	integer	None.
EntityName	NameDTO	None.
EntityStringName	string	None.
Entities	Collection of integer	None.
ChildEntities	Collection of integer	None.
ChildEntityID	integer	None.
ChildEntityName	NameDTO	None.
ChildEntityStringName	string	None.
ChildEntityType	EntityType	None.
ParentEntityID	integer	None.
ParentEntities	Collection of integer	None.
ParentEntityName	NameDTO	None.
ParentEntityStringName	string	None.
ParentEntityType	EntityType	None.
EntityRelationshipTypeEntryID	integer	None.
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
Match	MatchCriteriaStringType	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ContactRelationshipDTO

Name	Type	Additional information
ContactRelationshipID	integer	None.
ChildEntityID	integer	None.
ChildEntityType	EntityType	None.
ParentEntityID	integer	None.
ParentEntityType	EntityType	None.
ParentEntityName	NameDTO	None.
EntityRelationshipTypeEntryID	integer	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
EntityRelationshipTypeValue	string	None.
ContactRelationshipDetails	ContactRelationshipDetailsDTO	None.
Extensions	Collection of FormDataExtensionDto	None.
Comments	string	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "contactRelationshipID": 1,
    "childEntityID": 2,
    "childEntityType": 1,
    "parentEntityID": 3,
    "parentEntityType": 1,
    "parentEntityName": {
      "lastName": "sample string 1",
      "firstName": "sample string 2",
      "preferredName": "sample string 3",
      "middleName": "sample string 4",
      "prefix": "sample string 5",
      "suffix": "sample string 6",
      "summary": "sample string 1, sample string 2 (sample string 3)"
    },
    "entityRelationshipTypeEntryID": 4,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:02 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:02 AM"
    },
    "entityRelationshipTypeValue": "sample string 5",
    "contactRelationshipDetails": {
      "list": []
    },
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "comments": "sample string 6",
    "summary": "ContactRelationshipDTO"
  },
  {
    "contactRelationshipID": 1,
    "childEntityID": 2,
    "childEntityType": 1,
    "parentEntityID": 3,
    "parentEntityType": 1,
    "parentEntityName": {
      "lastName": "sample string 1",
      "firstName": "sample string 2",
      "preferredName": "sample string 3",
      "middleName": "sample string 4",
      "prefix": "sample string 5",
      "suffix": "sample string 6",
      "summary": "sample string 1, sample string 2 (sample string 3)"
    },
    "entityRelationshipTypeEntryID": 4,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:02 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:02 AM"
    },
    "entityRelationshipTypeValue": "sample string 5",
    "contactRelationshipDetails": {
      "list": []
    },
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:54:02.7625742+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "comments": "sample string 6",
    "summary": "ContactRelationshipDTO"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ContactRelationshipDTO>
    <ChildEntityID>2</ChildEntityID>
    <ChildEntityType>Organization</ChildEntityType>
    <Comments>sample string 6</Comments>
    <ContactRelationshipDetails>
      <List />
    </ContactRelationshipDetails>
    <ContactRelationshipID>1</ContactRelationshipID>
    <Created>
      <DateUtc>2024-12-04T07:54:02.7625742+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityRelationshipTypeEntryID>4</EntityRelationshipTypeEntryID>
    <EntityRelationshipTypeValue>sample string 5</EntityRelationshipTypeValue>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <LastUpdated>
      <DateUtc>2024-12-04T07:54:02.7625742+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <ParentEntityID>3</ParentEntityID>
    <ParentEntityName>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 1</LastName>
      <MiddleName>sample string 4</MiddleName>
      <PreferredName>sample string 3</PreferredName>
      <Prefix>sample string 5</Prefix>
      <Suffix>sample string 6</Suffix>
    </ParentEntityName>
    <ParentEntityType>Organization</ParentEntityType>
    <RecordState>Active</RecordState>
  </ContactRelationshipDTO>
  <ContactRelationshipDTO>
    <ChildEntityID>2</ChildEntityID>
    <ChildEntityType>Organization</ChildEntityType>
    <Comments>sample string 6</Comments>
    <ContactRelationshipDetails>
      <List />
    </ContactRelationshipDetails>
    <ContactRelationshipID>1</ContactRelationshipID>
    <Created>
      <DateUtc>2024-12-04T07:54:02.7625742+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityRelationshipTypeEntryID>4</EntityRelationshipTypeEntryID>
    <EntityRelationshipTypeValue>sample string 5</EntityRelationshipTypeValue>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:54:02.7625742+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <LastUpdated>
      <DateUtc>2024-12-04T07:54:02.7625742+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <ParentEntityID>3</ParentEntityID>
    <ParentEntityName>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 1</LastName>
      <MiddleName>sample string 4</MiddleName>
      <PreferredName>sample string 3</PreferredName>
      <Prefix>sample string 5</Prefix>
      <Suffix>sample string 6</Suffix>
    </ParentEntityName>
    <ParentEntityType>Organization</ParentEntityType>
    <RecordState>Active</RecordState>
  </ContactRelationshipDTO>
</ArrayOfContactRelationshipDTO>

application/x-compressed-json

Sample:

��T�J1~����j�鶅��U�m���fj�IvIRh)}2>��`�]Ѷ[<�"���|C�o~^�_FK��ڱ�݁dN��NEq��i�l*$?�N�E��
�`Q@U0�}��7]�q7Ly�Kf��Ɩ�B����b�0{P�����^��Jp.�N��|�x��&uP���bf�K8B[���C��0��;�U1�xI�
d������n�o� ���e>9%49��1I��v��Г^�vz	="$%�S�Y0{��WE�F1m%��U���@>�kX�B�^�&g�IB[k&��	i�Y��t4�hB�cY婖��A˅��F]��J�j���?،�*�%��t(�+�_��Y�
nq����%m.isI�K��K:~l���