Appearance
copyAddressesFromUserToDirectoryContact ​
Allows one or more User addresses to be copied down into a Directory i.e. Contact record within a single Company.
Request ​
http
POST /rest/smartdirectory/{directoryUUID}/contactRecord/addresses/copyFromUserHeaders ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
Path Params:
| Parameter | Type | Required | Description |
|---|---|---|---|
directoryUUID | String | Yes | UUID of the Smart Directory as setup in SAM |
Request Params:
| Parameter | Type | Required | Description |
|---|---|---|---|
addressUUIDs | List of Strings | Yes | List of Address UUIDs from User's profile to be copied down into the Directory (at least one required) |
JSON Request:
json
{
"addressUUIDs" : ["ADDRESS1_UUID", "ADDRESS2_UUID"]
}Response ​
200 OK ​
Returns the newly created addresses in the Directory
json
[
{
"uuid": "ADDRESS1_UUID",
"type": null,
"typeCode": null,
"name": "ADDRESS 1 NAME",
"street": "ADDRESS 1 STREET",
"city": null,
"suburb": null,
"stateCode": null,
"state": null,
"postcode": null,
"countryCode": null,
"country": null,
"email": null,
"phone": null,
"fax": null,
"mobile": null,
"department": null,
"division": null,
"jobTitle": null
},
{
"uuid": "ADDRESS2_UUID",
"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 ​
| Exception | Description |
|---|---|
WSInvalidAuthTokenException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSInvalidParameterException | See Error Definitions |
WSSmartDirectoryNotFoundException | See Error Definitions |
WSSmartDirectoryServiceException | See Error Definitions |
WSUserNotConsentedException | See Error Definitions |
WSSmartDirectoryNotEnabledForCompanyException | See Error Definitions |
WSUserContactNotFoundException | See Error Definitions |
WSUserNotInSmartDirectoryException | See Error Definitions |
WSSmartDirectoryInactiveException | See Error Definitions |
WSAddressServiceException | See Error Definitions |
WSAddressAlreadyFullException | See Error Definitions |
WSContactNotFoundException | See Error Definitions |
WSAddressAlreadyFullException | See Error Definitions |
WSAddressNotFoundException | See Error Definitions |
WSAlreadyExistsException | See Error Definitions |
WSNoAddressFieldsInDirectoryException | See Error Definitions |
WSLimitExceededException | See Error Definitions |