Skip to content

getUserAddresses ​

Returns all the addresses currently assigned to a given User's profile

Request ​

http
GET /rest/user/addresses

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

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"
    },
 {  
       "uuid":"55794f4e-b052-2d93-a045-c014d4aea7b1",
       "type":"Work",
       "typeCode":"W",
       "name":"Alfred Hospital",
       "street":"Alfred Street",
       "city":"Melbourne",
       "suburb":"City",
       "stateCode":"AU-VIC",
       "state":"Victoria",
       "postcode":"3000",
       "countryCode":"AU",
       "country":"AUSTRALIA",
       "email":"test@test.com",
       "phone":"phone",
       "fax":"fax",
       "mobile":"mobile",
      "department":"department",
       "division":"division",
       "jobTitle":"jobTitle"
    }
]

Errors ​

ExceptionDescription
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSAddressServiceExceptionSee Error Definitions
WSUserNotFoundExceptionSee Error Definitions