GET Clients/Order/{clientOrderId}/Contacts/Initialize

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientOrderId

integer

Required

Body Parameters

None.

Response Information

Resource Description

EntityDetailDTO
NameDescriptionTypeAdditional information
EntityID

integer

None.

EntityType

EntityType

None.

EntityName

NameDTO

None.

EntityEventState

RecordState

None.

EntityRelationships

EntityRelationshipsDTO

None.

EntityAddresses

AddressesDTO

None.

EntityCommunicationMethods

CommunicationMethodsDTO

None.

ImageEntityFileID

integer

None.

ImageEntityFileKey

string

None.

IsAbsent

boolean

None.

AbsentStatusName

string

None.

AbsentStatusDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "entityID": 1,
  "entityType": 1,
  "entityName": {
    "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)"
  },
  "entityEventState": 1,
  "entityRelationships": {},
  "imageEntityFileID": 1,
  "imageEntityFileKey": "sample string 2",
  "isAbsent": true,
  "absentStatusName": "sample string 4",
  "absentStatusDescription": "sample string 5"
}

application/xml, text/xml

Sample:
<EntityDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AbsentStatusDescription>sample string 5</AbsentStatusDescription>
  <AbsentStatusName>sample string 4</AbsentStatusName>
  <EntityAddresses>
    <List />
    <PartialData>FullData</PartialData>
  </EntityAddresses>
  <EntityCommunicationMethods>
    <List />
    <PartialData>FullData</PartialData>
    <PhoneNumbers />
  </EntityCommunicationMethods>
  <EntityEventState>Active</EntityEventState>
  <EntityID>1</EntityID>
  <EntityName>
    <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>
  </EntityName>
  <EntityRelationships>
    <List />
  </EntityRelationships>
  <EntityType>Organization</EntityType>
  <ImageEntityFileID>1</ImageEntityFileID>
  <ImageEntityFileKey>sample string 2</ImageEntityFileKey>
  <IsAbsent>true</IsAbsent>
</EntityDetailDTO>

application/x-compressed-json

Sample:
�u�M
�0��Rf�Ѝ���*��B�@�SHjȤb)=���Lk�ҟU��=f^����K6ۆL�Z�2�
����`���%zl
%Wo>�d��Qm0Fc0�u̜CQI���z=;h��qZVH)a�n`�ke�F�Hc(��_?�y��6K9���	�H�kǹI�+�+�!�u���v�
���FC`M�>�J�[Sl�i
�/�t�������B��