GET Contacts/Relationship/{contactRelationshipID}

Request Information

URI Parameters

Name	Description	Type	Additional information
contactRelationshipID		integer	Required

Body Parameters

None.

Response Information

Resource Description

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:45:27.2106737+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:45:27 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:45:27.2106737+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:45:27 AM"
  },
  "entityRelationshipTypeValue": "sample string 5",
  "contactRelationshipDetails": {
    "list": []
  },
  "extensions": [
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:45:27.2106737+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:45:27.2106737+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:45:27.2106737+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:45:27.2106737+00:00",
        "userName": "sample string 2"
      }
    }
  ],
  "comments": "sample string 6",
  "summary": "ContactRelationshipDTO"
}

application/xml, text/xml

Sample:

<ContactRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ChildEntityID>2</ChildEntityID>
  <ChildEntityType>Organization</ChildEntityType>
  <Comments>sample string 6</Comments>
  <ContactRelationshipDetails>
    <List />
  </ContactRelationshipDetails>
  <ContactRelationshipID>1</ContactRelationshipID>
  <Created>
    <DateUtc>2024-12-04T07:45:27.2106737+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EntityRelationshipTypeEntryID>4</EntityRelationshipTypeEntryID>
  <EntityRelationshipTypeValue>sample string 5</EntityRelationshipTypeValue>
  <Extensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T07:45:27.2106737+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T07:45:27.2106737+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T07:45:27.2106737+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T07:45:27.2106737+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
  </Extensions>
  <LastUpdated>
    <DateUtc>2024-12-04T07:45:27.2106737+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>

application/x-compressed-json

Sample:

��SMK1�+!'ŭͦk�&VA���"=�ͬ
&�%I���/��O�/�lW��O��m2�y�f���u��R;��;�̉Rۙ�.G8�#�τ���	���/+hX3��'m�����0�+,�u�[�*	�:#��q�a��ԣ�����x��K脓��؁N<d�E4l ��Y�
�ЖFt�%������f��+�1/����4��1��-7�C��>�����&���H2&i��d4=�1��􈐌/un��o_�Ŵ��C	���N���0�I����n/���	c���8&�mvQX���i�x�@�@�U[�=��m�(�� ��������pu����a;���o���c�Ʒ�~"���L