GET Contacts/Group

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	MatchCriteriaStringType	None.
EntityIDs	Collection of integer	None.
BusinessUnits	Collection of integer	None.
GroupIDs	Collection of integer	None.
Status	integer	None.
BusinessUnitStatusTypes	Collection of integer	None.
StatusReason	string	None.
StatusReason2	string	None.
StatusReason3	string	None.
StatusReason3List	Collection of string	None.
StatusComments	string	None.
StartDateUtcMin	date	None.
StartDateUtcMax	date	None.
StopDateUtcMin	date	None.
StopDateUtcMax	date	None.
MaxRows	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ContactGroupDTO

Name	Type	Additional information
ContactID	integer	None.
BUID	integer	None.
GroupID	integer	None.
BusinessUnitStatusID	integer	None.
StatusReason	string	None.
StatusReason2	string	None.
StatusComments	string	None.
StartDateUtc	date	None.
StopDateUtc	date	None.
RecordState	RecordState	None.
ReferralSource	string	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
StatusName	string	None.
GroupName	string	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "contactID": 1,
    "buid": 2,
    "groupID": 3,
    "businessUnitStatusID": 4,
    "statusReason": "sample string 5",
    "statusReason2": "sample string 6",
    "statusComments": "sample string 7",
    "startDateUtc": "2024-12-04T08:08:07.144124+00:00",
    "stopDateUtc": "2024-12-04T08:08:07.144124+00:00",
    "recordState": 1,
    "referralSource": "sample string 9",
    "created": {
      "dateUtc": "2024-12-04T08:08:07.144124+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:08:07 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:08:07.144124+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:08:07 AM"
    },
    "statusName": "sample string 10",
    "groupName": "sample string 11",
    "summary": "ContactGroupDTO"
  },
  {
    "contactID": 1,
    "buid": 2,
    "groupID": 3,
    "businessUnitStatusID": 4,
    "statusReason": "sample string 5",
    "statusReason2": "sample string 6",
    "statusComments": "sample string 7",
    "startDateUtc": "2024-12-04T08:08:07.144124+00:00",
    "stopDateUtc": "2024-12-04T08:08:07.144124+00:00",
    "recordState": 1,
    "referralSource": "sample string 9",
    "created": {
      "dateUtc": "2024-12-04T08:08:07.144124+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:08:07 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:08:07.144124+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:08:07 AM"
    },
    "statusName": "sample string 10",
    "groupName": "sample string 11",
    "summary": "ContactGroupDTO"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactGroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ContactGroupDTO>
    <BUID>2</BUID>
    <BusinessUnitStatusID>4</BusinessUnitStatusID>
    <ContactID>1</ContactID>
    <Created>
      <DateUtc>2024-12-04T08:08:07.144124+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <GroupID>3</GroupID>
    <GroupName>sample string 11</GroupName>
    <LastUpdated>
      <DateUtc>2024-12-04T08:08:07.144124+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <ReferralSource>sample string 9</ReferralSource>
    <StartDateUtc>2024-12-04T08:08:07.144124+00:00</StartDateUtc>
    <StatusComments>sample string 7</StatusComments>
    <StatusName>sample string 10</StatusName>
    <StatusReason>sample string 5</StatusReason>
    <StatusReason2>sample string 6</StatusReason2>
    <StopDateUtc>2024-12-04T08:08:07.144124+00:00</StopDateUtc>
  </ContactGroupDTO>
  <ContactGroupDTO>
    <BUID>2</BUID>
    <BusinessUnitStatusID>4</BusinessUnitStatusID>
    <ContactID>1</ContactID>
    <Created>
      <DateUtc>2024-12-04T08:08:07.144124+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <GroupID>3</GroupID>
    <GroupName>sample string 11</GroupName>
    <LastUpdated>
      <DateUtc>2024-12-04T08:08:07.144124+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <ReferralSource>sample string 9</ReferralSource>
    <StartDateUtc>2024-12-04T08:08:07.144124+00:00</StartDateUtc>
    <StatusComments>sample string 7</StatusComments>
    <StatusName>sample string 10</StatusName>
    <StatusReason>sample string 5</StatusReason>
    <StatusReason2>sample string 6</StatusReason2>
    <StopDateUtc>2024-12-04T08:08:07.144124+00:00</StopDateUtc>
  </ContactGroupDTO>
</ArrayOfContactGroupDTO>

application/x-compressed-json

Sample:

�풱N�0�_ź����PȆ	1m&�`������Pœ1�H�q���t�R%/���������|�B�l�U�- �Ħ�\f�!�<KA�X��MX�O	��.������צk��@�ݰs�䄸�%����O�ňP(t�2T= �T3!g\��e���T(%�:�<�|�p�A���:�
�5�"�nW.R����������em�>D*z�{m�Me<��m�c�2!�j��Okv}��ڇ����4���)��`��i����y��b���>��h��b��obQ��^