createUserAddress

Creates a new Address for User. NOTE: there is an upper limit of 4 addresses.

Request

POST /rest/user/addresses

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

JSON Request.

Parameter	Type	Required	Description
typeCode	char(1)	No	The type of the Address. Either W=Work, P=Personal, or O=Other.
name	char(255)	No	Name of the address e.g. Alfred Hospital
street	char(255)	No	Street of the address e.g. 123 Whatever Street
city	char(100)	No	City of the address e.g. Melbourne
suburb	char(100)	No	Suburb of the address e.g. Alfred Hospital
stateCode	char(6)	No	ISO State Code of the address e.g. AU-VIC. Should only use values sourced from getStates /refdata/states API.
postCode	char(20)	No	Postcode of the address e.g. 3000
countryCode	char(2)	No	ISO Country Code of the address e.g. AU. Should only use values sourced from getCountries /refdata/countries API.
email	char(255)	No	Email associated with the address e.g. some@email.address
phone	char(30)	No	Phone associated with the address e.g. 03 789546757
fax	char(30)	No	Fax associated with the address e.g. 03 789546757
mobile	char(30)	No	Mobile associated with the address e.g. 0404444444
department	char(50)	No	Department associated with the address e.g. Radiology
division	char(50)	No	Division associated with the address e.g. Oncology
jobTitle	char(50)	No	Job title associated with the address e.g. Head of Radiooncology

{
   "typeCode":"W",
   "name":"Address 1 Name",
   "street":"Address 1 Street",
   "city":"Address 1 City",
   "suburb":"Address 1 Suburb",
   "stateCode":"AU-NSW",
   "postcode":"2000",
   "countryCode":"AU",
   "email":"test@test.com",
   "phone":"phone",
   "fax":"fax",
   "mobile":"mobile",
   "department":"department",
   "division":"division",
   "jobTitle":"jobTitle"
}

Response

200 OK

HTTP 200 and returns the newly created entity. NOTE: the addition of the uuid when successful.

{  
       "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

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSAddressServiceException	See Error Definitions
WSAlreadyExistsException	See Error Definitions
WSAddressAlreadyFullException	See Error Definitions
WSUserNotFoundException	See Error Definitions
WSFieldLengthException	See Error Definitions