GET api/v1/addressbook/groups/{groupID}/contacts?count={count}&startIndex={startIndex}

This method returns a list of all the contacts that are in the group specified. It will also include the details for each contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
count

Determines how many groups to return.(Default : 20)

string

Required

startIndex

Determines the index to start outputting the groups from a list returned from the database. (Default : 0)

string

Required

groupID

The ID of the group to fetch the contacts for.

string

Required

Body Parameters

None.

Response Information

Resource Description

List of contacts assigned to the group

ResponseOfAddressBook[]
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAddressBook[]

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": [
      {
        "PersonNumber": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "MobilePhone": "sample string 4",
        "EmailAddress": "sample string 5",
        "Password": "sample string 6",
        "LoginType": 7,
        "DateCreated": "2017-09-24T12:20:47.8667707Z",
        "DateModified": "2017-09-24T12:20:47.8667707Z",
        "LastModifiedBy": "sample string 8",
        "VetoValidation": true
      },
      {
        "PersonNumber": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "MobilePhone": "sample string 4",
        "EmailAddress": "sample string 5",
        "Password": "sample string 6",
        "LoginType": 7,
        "DateCreated": "2017-09-24T12:20:47.8667707Z",
        "DateModified": "2017-09-24T12:20:47.8667707Z",
        "LastModifiedBy": "sample string 8",
        "VetoValidation": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfAddressBook 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>
      <AddressBook>
        <PersonNumber>1</PersonNumber>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
        <MobilePhone>sample string 4</MobilePhone>
        <EmailAddress>sample string 5</EmailAddress>
        <Password>sample string 6</Password>
        <LoginType>7</LoginType>
        <DateCreated>2017-09-24T12:20:47.8667707Z</DateCreated>
        <DateModified>2017-09-24T12:20:47.8667707Z</DateModified>
        <LastModifiedBy>sample string 8</LastModifiedBy>
        <VetoValidation>true</VetoValidation>
      </AddressBook>
      <AddressBook>
        <PersonNumber>1</PersonNumber>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
        <MobilePhone>sample string 4</MobilePhone>
        <EmailAddress>sample string 5</EmailAddress>
        <Password>sample string 6</Password>
        <LoginType>7</LoginType>
        <DateCreated>2017-09-24T12:20:47.8667707Z</DateCreated>
        <DateModified>2017-09-24T12:20:47.8667707Z</DateModified>
        <LastModifiedBy>sample string 8</LastModifiedBy>
        <VetoValidation>true</VetoValidation>
      </AddressBook>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAddressBook>