POST api/UserManagement/GetContactsGroup

Get contacts group

Request Information

URI Parameters

None.

Body Parameters

Contacts group ids details

ContactGroupsRequestDto
NameDescriptionTypeAdditional information
GroupIds

Collection of integer

None.

RetriveSecondaryContacts

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "GroupIds": [
    1,
    2
  ],
  "RetriveSecondaryContacts": true
}

application/xml, text/xml

Sample:
<ContactGroupsRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enTT.ZS.Dto.User">
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </GroupIds>
  <RetriveSecondaryContacts>true</RetriveSecondaryContacts>
</ContactGroupsRequestDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Contacts group(s) details

ResponseOfListOfContactGroupDto
NameDescriptionTypeAdditional information
StatusCode

StatusCode

None.

Message

string

None.

Data

Collection of ContactGroupDto

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 1000,
  "Message": "sample string 1",
  "Data": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Contacts": [
        {
          "PrimaryContact": {
            "ContactId": 1,
            "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
            "Name": "sample string 4",
            "ThumbnailURL": "sample string 5",
            "IsLocked": true
          },
          "SecondaryContact": [
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            },
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            }
          ]
        },
        {
          "PrimaryContact": {
            "ContactId": 1,
            "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
            "Name": "sample string 4",
            "ThumbnailURL": "sample string 5",
            "IsLocked": true
          },
          "SecondaryContact": [
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            },
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            }
          ]
        }
      ],
      "OrganizationId": 4,
      "Thumbnail": "sample string 7",
      "DepartmentId": 8
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Contacts": [
        {
          "PrimaryContact": {
            "ContactId": 1,
            "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
            "Name": "sample string 4",
            "ThumbnailURL": "sample string 5",
            "IsLocked": true
          },
          "SecondaryContact": [
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            },
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            }
          ]
        },
        {
          "PrimaryContact": {
            "ContactId": 1,
            "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
            "Name": "sample string 4",
            "ThumbnailURL": "sample string 5",
            "IsLocked": true
          },
          "SecondaryContact": [
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            },
            {
              "ContactId": 1,
              "ContactProfileId": "I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D",
              "Name": "sample string 4",
              "ThumbnailURL": "sample string 5",
              "IsLocked": true
            }
          ]
        }
      ],
      "OrganizationId": 4,
      "Thumbnail": "sample string 7",
      "DepartmentId": 8
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfContactGroupDtokvwhp91_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enTT.ZS.Dto">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/enTT.ZS.Dto.User">
    <d2p1:ContactGroupDto>
      <d2p1:Contacts>
        <d2p1:UserGroupContactItemDto>
          <d2p1:PrimaryContact>
            <d2p1:ContactId>1</d2p1:ContactId>
            <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
            <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
            <d2p1:IsLocked>true</d2p1:IsLocked>
            <d2p1:Name>sample string 4</d2p1:Name>
            <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
          </d2p1:PrimaryContact>
          <d2p1:SecondaryContact>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
          </d2p1:SecondaryContact>
        </d2p1:UserGroupContactItemDto>
        <d2p1:UserGroupContactItemDto>
          <d2p1:PrimaryContact>
            <d2p1:ContactId>1</d2p1:ContactId>
            <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
            <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
            <d2p1:IsLocked>true</d2p1:IsLocked>
            <d2p1:Name>sample string 4</d2p1:Name>
            <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
          </d2p1:PrimaryContact>
          <d2p1:SecondaryContact>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
          </d2p1:SecondaryContact>
        </d2p1:UserGroupContactItemDto>
      </d2p1:Contacts>
      <d2p1:CreatedBy>5</d2p1:CreatedBy>
      <d2p1:DepartmentId>8</d2p1:DepartmentId>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:ModifiedBy>6</d2p1:ModifiedBy>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:OrganizationId>4</d2p1:OrganizationId>
      <d2p1:Thumbnail>sample string 7</d2p1:Thumbnail>
    </d2p1:ContactGroupDto>
    <d2p1:ContactGroupDto>
      <d2p1:Contacts>
        <d2p1:UserGroupContactItemDto>
          <d2p1:PrimaryContact>
            <d2p1:ContactId>1</d2p1:ContactId>
            <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
            <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
            <d2p1:IsLocked>true</d2p1:IsLocked>
            <d2p1:Name>sample string 4</d2p1:Name>
            <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
          </d2p1:PrimaryContact>
          <d2p1:SecondaryContact>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
          </d2p1:SecondaryContact>
        </d2p1:UserGroupContactItemDto>
        <d2p1:UserGroupContactItemDto>
          <d2p1:PrimaryContact>
            <d2p1:ContactId>1</d2p1:ContactId>
            <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
            <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
            <d2p1:IsLocked>true</d2p1:IsLocked>
            <d2p1:Name>sample string 4</d2p1:Name>
            <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
          </d2p1:PrimaryContact>
          <d2p1:SecondaryContact>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
            <d2p1:UserGroupContactDto>
              <d2p1:ContactId>1</d2p1:ContactId>
              <d2p1:ContactProfileId>I68bl%2F7%2BpGcxQqGZQQUuRQ%3D%3D</d2p1:ContactProfileId>
              <d2p1:ContactProfileIdNum>2</d2p1:ContactProfileIdNum>
              <d2p1:IsLocked>true</d2p1:IsLocked>
              <d2p1:Name>sample string 4</d2p1:Name>
              <d2p1:ThumbnailURL>sample string 5</d2p1:ThumbnailURL>
            </d2p1:UserGroupContactDto>
          </d2p1:SecondaryContact>
        </d2p1:UserGroupContactItemDto>
      </d2p1:Contacts>
      <d2p1:CreatedBy>5</d2p1:CreatedBy>
      <d2p1:DepartmentId>8</d2p1:DepartmentId>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:ModifiedBy>6</d2p1:ModifiedBy>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:OrganizationId>4</d2p1:OrganizationId>
      <d2p1:Thumbnail>sample string 7</d2p1:Thumbnail>
    </d2p1:ContactGroupDto>
  </Data>
  <Message>sample string 1</Message>
  <Result />
  <StatusCode>Success</StatusCode>
</ResponseOfArrayOfContactGroupDtokvwhp91_P>