Skip to content

getAddressForDirectoryContact ​

Returns a single Contact Address for a given Contact in a given Directory, normally for the purposes of viewing/updating.

Request ​

http
GET /rest/smartdirectory/{directoryUUID}/contactRecord/addresses/{addressUUID}

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

directoryUUID - String. UUID of the Smart Directory as set up in SAM. addressUUID - String. UUID of a Contact Address.

Response ​

200 OK ​

json
{
  "uuid": "75594f4e-d053-4c93-b045-d013d4aea3c0",
  "type": "Work",
  "typeCode": "W",
  "name": "Address 1 Name",
  "street": "Address 1 Street",
  "city": "Address 1 City",
  "suburb": "Address 1 Suburb",
  "stateCode": "AU-NSW",
  "state": "New South Wales",
  "postcode": "2000",
  "countryCode": "AU",
  "country": "AUSTRALIA",
  "email": "test@test.com",
  "phone": "phone",
  "fax": "fax",
  "mobile": "mobile",
  "department": "department",
  "division": "division",
  "jobTitle": "jobTitle"
}

Errors ​

ExceptionDescription
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSSmartDirectoryNotFoundExceptionSee Error Definitions
WSSmartDirectoryServiceExceptionSee Error Definitions
WSUserNotConsentedExceptionSee Error Definitions
WSSmartDirectoryNotEnabledForCompanyExceptionSee Error Definitions
WSUserContactNotFoundExceptionSee Error Definitions
WSUserNotInSmartDirectoryExceptionSee Error Definitions
WSSmartDirectoryInactiveExceptionSee Error Definitions
WSAddressServiceExceptionSee Error Definitions
WSContactNotFoundExceptionSee Error Definitions
WSAddressNotFoundExceptionSee Error Definitions
WSNoAddressFieldsInDirectoryExceptionSee Error Definitions