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.

TwoSms.CustomerPortalRole.API.AddressBooks.Group

Name	Description	Type	Additional information
GroupName	The name of the group.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "GroupName": "sample string 1",
  "GroupID": "sample string 2"
}

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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The group details that have been posted.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.AddressBooks.Group

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.AddressBooks.Group	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",
      "GroupID": "sample string 2"
    }
  }
}

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>