GET Clients/RelationshipDetail

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeActive

boolean

None.

IncludeInactive

boolean

None.

IncludeDeleted

boolean

None.

Match

MatchCriteriaStringType

None.

EntityIDs

Collection of integer

None.

EntityRelationshipIDs

Collection of integer

None.

ChildEntityID

integer

None.

ParentEntityID

integer

None.

EntityRelationshipTypeEntryID

integer

None.

Comments

string

None.

CreatedDateUtcMin

date

None.

CreatedDateUtcMax

date

None.

LastUpdatedDateUtcMin

date

None.

LastUpdatedDateUtcMax

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ClientRelationshipDetailDTO
NameDescriptionTypeAdditional information
ClientID

integer

None.

EntityRelationshipID

integer

None.

SortOrder

integer

None.

Comments

string

None.

RecordState

RecordState

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

Summary

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "clientID": 1,
    "entityRelationshipID": 2,
    "sortOrder": 3,
    "comments": "sample string 4",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:59:36.3169562+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:59:36 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:59:36.3169562+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:59:36 AM"
    },
    "summary": "ClientRelationshipDTO"
  },
  {
    "clientID": 1,
    "entityRelationshipID": 2,
    "sortOrder": 3,
    "comments": "sample string 4",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:59:36.3169562+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:59:36 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:59:36.3169562+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:59:36 AM"
    },
    "summary": "ClientRelationshipDTO"
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientRelationshipDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ClientRelationshipDetailDTO>
    <ClientID>1</ClientID>
    <Comments>sample string 4</Comments>
    <Created>
      <DateUtc>2024-12-04T07:59:36.3169562+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityRelationshipID>2</EntityRelationshipID>
    <LastUpdated>
      <DateUtc>2024-12-04T07:59:36.3169562+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <SortOrder>3</SortOrder>
  </ClientRelationshipDetailDTO>
  <ClientRelationshipDetailDTO>
    <ClientID>1</ClientID>
    <Comments>sample string 4</Comments>
    <Created>
      <DateUtc>2024-12-04T07:59:36.3169562+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityRelationshipID>2</EntityRelationshipID>
    <LastUpdated>
      <DateUtc>2024-12-04T07:59:36.3169562+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <SortOrder>3</SortOrder>
  </ClientRelationshipDetailDTO>
</ArrayOfClientRelationshipDetailDTO>

application/x-compressed-json

Sample:
��Q�j1~�0�ƚͮ[�M��Z=�B2h`�Y&�A�'��G�+4J�_�Co|�|_���#�.`���JBA���Y�ϻ0\-!'�y$0��b,���C�"3�~+�@��7���LGX�s_��]�i��Q�G�Y�'3���}��v:i��RF���H/6�M�.d��h�pˉԋJ���B�d��3�$t6�f��rίi~����U���s��||�w�+B