POST api/UserManagement/CreateContactGroup

Create group in address book

Request Information

URI Parameters

None.

Body Parameters

Group details and contacts details

ContactGroupDto
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Description

string

None.

Contacts

Collection of UserGroupContactItemDto

None.

OrganizationId

integer

None.

Thumbnail

string

None.

DepartmentId

integer

None.

Request Formats

application/json, text/json

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Group id

ResponseOfInt32
NameDescriptionTypeAdditional information
StatusCode

StatusCode

None.

Message

string

None.

Data

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 1000,
  "Message": "sample string 1",
  "Data": 2
}

application/xml, text/xml

Sample:
<ResponseOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enTT.ZS.Dto">
  <Data>2</Data>
  <Message>sample string 1</Message>
  <Result />
  <StatusCode>Success</StatusCode>
</ResponseOfint>