GET api/Users/ByPostcode/{code}

GET details for users with given postcode

Request Information

URI Parameters

NameDescriptionTypeAdditional information
code

Postcode

string

Required

Body Parameters

None.

Response Information

Resource Description

UserReportDetails()

UserReportDetails
NameDescriptionTypeAdditional information
userID

Unique user identifier

integer

None.

userFirstName

Users first name(s)

string

None.

userSurname

Users surname

string

None.

userPostcode

Users postcode

string

None.

userEmail

Users email

string

None.

userAccountingSystemRef

Accounting reference for use in external systems (such as MYOB)

string

None.

userTitle

Users Title

string

None.

userGender

Users Gender

integer

None.

userDescription

Users Description

string

None.

userDepartment

Users Department

integer

None.

userLevel

Users Level

integer

None.

userManagerID

Users Managers unique identifier

integer

None.

userAddress1

Users Address

string

None.

userAddress2

Users second address line

string

None.

userCordinates

Users Coordinates (GPS)

string

None.

userState

Users state of residence

string

None.

userPhone

Users contact phone

string

None.

userMobile

Users Mobile number

string

None.

userQualification

Users Qualifications

string

None.

userNotifySMS

User is notified by SMS

boolean

None.

userNotifyEmail

User is notified by email

boolean

None.

userCareWorker

Users care worker

boolean

None.

userDisabled

User is disabled

boolean

None.

userLanguages

List of languages User is able to speak

string

None.

userDOB

Users Date of Birth

date

None.

userPaylevel

User current Pay Level in local system

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "userID": 707,
  "userFirstName": "Jack",
  "userSurname": "Sparrow",
  "userPostcode": "1234",
  "userEmail": "jsparrow@notarealdomain.com",
  "userAccountingSystemRef": "sample string 2",
  "userTitle": "Mr",
  "userGender": 1,
  "userDescription": "sample string 3",
  "userDepartment": 534,
  "userLevel": 581,
  "userManagerID": 291,
  "userAddress1": "SS Minnow",
  "userAddress2": "123 Reallylong St",
  "userCordinates": "sample string 4",
  "userState": "NSW",
  "userPhone": "0712345678",
  "userMobile": "0400123456",
  "userQualification": "sample string 5",
  "userNotifySMS": true,
  "userNotifyEmail": true,
  "userCareWorker": true,
  "userDisabled": true,
  "userLanguages": "French,German",
  "userDOB": "2024-03-30T02:06:22.0501279+11:00",
  "userPaylevel": 303
}

application/xml, text/xml

Sample:
<UserReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint">
  <userAccountingSystemRef>sample string 2</userAccountingSystemRef>
  <userAddress1>SS Minnow</userAddress1>
  <userAddress2>123 Reallylong St</userAddress2>
  <userCareWorker>true</userCareWorker>
  <userCordinates>sample string 4</userCordinates>
  <userDOB>2024-03-30T02:06:22.0501279+11:00</userDOB>
  <userDepartment>534</userDepartment>
  <userDescription>sample string 3</userDescription>
  <userDisabled>true</userDisabled>
  <userEmail>jsparrow@notarealdomain.com</userEmail>
  <userFirstName>Jack</userFirstName>
  <userGender>1</userGender>
  <userID>707</userID>
  <userLanguages>French,German</userLanguages>
  <userLevel>581</userLevel>
  <userManagerID>291</userManagerID>
  <userMobile>0400123456</userMobile>
  <userNotifyEmail>true</userNotifyEmail>
  <userNotifySMS>true</userNotifySMS>
  <userPaylevel>303</userPaylevel>
  <userPhone>0712345678</userPhone>
  <userPostcode>1234</userPostcode>
  <userQualification>sample string 5</userQualification>
  <userState>NSW</userState>
  <userSurname>Sparrow</userSurname>
  <userTitle>Mr</userTitle>
</UserReportDetails>