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

Name	Description	Type	Additional information
contactID	The Id of the contact.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A contact that the authenticated user is allowed to view.

ResponseOfAddressBookResponse

Name	Description	Type	Additional 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": {
      "PersonNumber": 3,
      "DateCreated": "2024-11-21T09:10:15.2488297+00:00",
      "DateModified": "2024-11-21T09:10:15.2488297+00:00",
      "EmailAddress": "sample string 9",
      "FirstName": "sample string 6",
      "Groups": "sample string 2",
      "Inherited": true,
      "LastName": "sample string 7",
      "LastModifiedBy": "sample string 4",
      "MobilePhone": "sample string 8",
      "LoginType": 11,
      "OwnerAccountID": "3e6cf966-cf75-4221-99f1-33d40c29ae54",
      "Password": "sample string 10",
      "PermissionLevel": 0,
      "Validated": 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>
      <Validated>true</Validated>
      <PersonNumber>3</PersonNumber>
      <DateCreated>2024-11-21T09:10:15.2488297+00:00</DateCreated>
      <DateModified>2024-11-21T09:10:15.2488297+00:00</DateModified>
      <LastModifiedBy>sample string 4</LastModifiedBy>
      <OwnerAccountID>3e6cf966-cf75-4221-99f1-33d40c29ae54</OwnerAccountID>
      <Inherited>true</Inherited>
      <PermissionLevel>NONE</PermissionLevel>
      <Groups>sample string 2</Groups>
    </Detail>
  </ResponseData>
</ResponseOfAddressBookResponse>