GET api/v1/addressbook/groups/{groupID}

This method returns a group stored on the customer’s account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupID

Unique indentifier for the group in question.

string

Required

Body Parameters

None.

Response Information

Resource Description

Group Details.

ResponseOfGroupDetails
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfGroupDetails

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": {
      "GroupID": "sample string 1",
      "Groupname": "sample string 2",
      "DateCreated": "sample string 3",
      "DateModified": "sample string 4",
      "Contacts": 5,
      "LastModifiedBy": "sample string 6"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfGroupDetails 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>
      <GroupID>sample string 1</GroupID>
      <Groupname>sample string 2</Groupname>
      <DateCreated>sample string 3</DateCreated>
      <DateModified>sample string 4</DateModified>
      <Contacts>5</Contacts>
      <LastModifiedBy>sample string 6</LastModifiedBy>
    </Detail>
  </ResponseData>
</ResponseOfGroupDetails>