GET api/v1/addressbook/contacts/{contactID}

This method returns the details of the specified contact. This detail of the contact will include their first name, last name, mobile number, email address and the type of authentication the contact has chosen if used with an SMS+ message. The system checks the contact ID is valid and belongs to the account

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

The Id of the contact.

string

Required

Body Parameters

None.

Response Information

Resource Description

A contact that the authenticated user is allowed to view.

ResponseOfAddressBookResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAddressBookResponse

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": {
      "PermissionDetails": "sample string 1",
      "PersonNumber": 3,
      "DateCreated": "2018-08-21T17:52:45.2934906+01:00",
      "DateModified": "2018-08-21T17:52:45.2934906+01:00",
      "LastModifiedBy": "sample string 4",
      "LegacyPersonNumber": 1,
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "MobilePhone": "sample string 8",
      "EmailAddress": "sample string 9",
      "Password": "sample string 10",
      "LoginType": 11,
      "VetoValidation": true
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfAddressBookResponse 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>
      <FirstName>sample string 6</FirstName>
      <LastName>sample string 7</LastName>
      <MobilePhone>sample string 8</MobilePhone>
      <EmailAddress>sample string 9</EmailAddress>
      <Password>sample string 10</Password>
      <LoginType>11</LoginType>
      <VetoValidation>true</VetoValidation>
      <PersonNumber>3</PersonNumber>
      <DateCreated>2018-08-21T17:52:45.2934906+01:00</DateCreated>
      <DateModified>2018-08-21T17:52:45.2934906+01:00</DateModified>
      <LastModifiedBy>sample string 4</LastModifiedBy>
      <OwnerAccountID>bce306a6-0528-461b-92a1-c5d1fa72882e</OwnerAccountID>
      <LegacyPersonNumber>1</LegacyPersonNumber>
      <PermissionDetails>sample string 1</PermissionDetails>
      <PermissionLevel>2</PermissionLevel>
    </Detail>
  </ResponseData>
</ResponseOfAddressBookResponse>