GET Clients/CommunicationMethod

Request Information

URI Parameters

Name	Type	Additional information
IncludeExpired	boolean	None.
EntityID	integer	None.
EntityIDs	Collection of integer	None.
CommunicationMethodTypeEntryID	integer	None.
Type	CommunicationMethodType	None.
StartDateUtcMin	date	None.
StartDateUtcMax	date	None.
StopDateUtcMin	date	None.
StopDateUtcMax	date	None.
Value	string	None.
SubValue	string	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 CommunicationMethodDTO

Name	Type	Additional information
CommunicationMethodID	integer	None.
EntityID	integer	None.
CommunicationMethodTypeEntryID	integer	None.
Type	CommunicationMethodType	None.
StartDateUtc	date	None.
StopDateUtc	date	None.
Value	string	None.
SubValue	string	None.
SortOrder	integer	None.
PartialData	PartialDataType	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Summary	string	None.
CommunicationMethodTypeEntryValue	string	None.
IsPrimary	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "communicationMethodID": 1,
    "entityID": 2,
    "communicationMethodTypeEntryID": 3,
    "type": 1,
    "startDateUtc": "2024-12-04T08:06:23.0330643+00:00",
    "stopDateUtc": "2024-12-04T08:06:23.0330643+00:00",
    "value": "sample string 5",
    "subValue": "sample string 6",
    "sortOrder": 7,
    "partialData": 1,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:06:23.0330643+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:06:23.0330643+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
    },
    "summary": "sample string 5 xsample string 6",
    "communicationMethodTypeEntryValue": "sample string 8",
    "isPrimary": true
  },
  {
    "communicationMethodID": 1,
    "entityID": 2,
    "communicationMethodTypeEntryID": 3,
    "type": 1,
    "startDateUtc": "2024-12-04T08:06:23.0330643+00:00",
    "stopDateUtc": "2024-12-04T08:06:23.0330643+00:00",
    "value": "sample string 5",
    "subValue": "sample string 6",
    "sortOrder": 7,
    "partialData": 1,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:06:23.0330643+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:06:23.0330643+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
    },
    "summary": "sample string 5 xsample string 6",
    "communicationMethodTypeEntryValue": "sample string 8",
    "isPrimary": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCommunicationMethodDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CommunicationMethodDTO>
    <CommunicationMethodID>1</CommunicationMethodID>
    <CommunicationMethodTypeEntryID>3</CommunicationMethodTypeEntryID>
    <CommunicationMethodTypeEntryValue>sample string 8</CommunicationMethodTypeEntryValue>
    <Created>
      <DateUtc>2024-12-04T08:06:23.0330643+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityID>2</EntityID>
    <IsPrimary>true</IsPrimary>
    <LastUpdated>
      <DateUtc>2024-12-04T08:06:23.0330643+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <PartialData>FullData</PartialData>
    <RecordState>Active</RecordState>
    <SortOrder>7</SortOrder>
    <StartDateUtc>2024-12-04T08:06:23.0330643+00:00</StartDateUtc>
    <StopDateUtc>2024-12-04T08:06:23.0330643+00:00</StopDateUtc>
    <SubValue>sample string 6</SubValue>
    <Type>Phone</Type>
    <Value>sample string 5</Value>
  </CommunicationMethodDTO>
  <CommunicationMethodDTO>
    <CommunicationMethodID>1</CommunicationMethodID>
    <CommunicationMethodTypeEntryID>3</CommunicationMethodTypeEntryID>
    <CommunicationMethodTypeEntryValue>sample string 8</CommunicationMethodTypeEntryValue>
    <Created>
      <DateUtc>2024-12-04T08:06:23.0330643+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityID>2</EntityID>
    <IsPrimary>true</IsPrimary>
    <LastUpdated>
      <DateUtc>2024-12-04T08:06:23.0330643+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <PartialData>FullData</PartialData>
    <RecordState>Active</RecordState>
    <SortOrder>7</SortOrder>
    <StartDateUtc>2024-12-04T08:06:23.0330643+00:00</StartDateUtc>
    <StopDateUtc>2024-12-04T08:06:23.0330643+00:00</StopDateUtc>
    <SubValue>sample string 6</SubValue>
    <Type>Phone</Type>
    <Value>sample string 5</Value>
  </CommunicationMethodDTO>
</ArrayOfCommunicationMethodDTO>

application/x-compressed-json

Sample:

�풱N�0�_ź�:N*oHe`( Ѳ [`)���U}2�W�	l	H�@����������~��"TU�]�������
T��zr����Sc����pI9P�aCi��n�R�l�ș�6b�D�dz*�T�Yz"�zI�S�貍v��.-k�b�~W�x7���f@�Fc��:�:]Fg=��-�[�$C]��Oj� ���x��1��Jc7��Y"�ټ�`߻���J�ж6�'т����[x��jU��A�eB��=?����ևO����^