POST api/v1/addressbook/groups

This method creates an empty group for the user to add contacts to. The system will check that the name of the group is not already present for that account.

Request Information

URI Parameters

None.

Body Parameters

Either xml or json request.

Group
NameDescriptionTypeAdditional information
Groupname

The name of the group.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Groupname": "sample string 1"
}

application/xml, text/xml

Sample:
<Group xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Groupname>sample string 1</Groupname>
  <GroupId>sample string 2</GroupId>
</Group>

Response Information

Resource Description

The group details that have been posted.

ResponseOfGroup
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfGroup

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "Groupname": "sample string 1"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Groupname>sample string 1</Groupname>
      <GroupId>sample string 2</GroupId>
    </Detail>
  </ResponseData>
</ResponseOfGroup>