POST api/Users

API Interface handling general JSON requests for user details

Request Information

URI Parameters

None.

Body Parameters

UserRequest

Name	Description	Type	Additional information
Id	Id As Integer	integer	None.
FirstName	Users Firstname to match. Can use ",' to separate a list of names OR ":" to specify a range of names to search between)	string	None.
LastName	Users Surname to match. Can use ",' to separate a list of names OR ":" to specify a range of names to search between)	string	None.
FirstNameLike	First name pattern to match against (if no pattern chars are detected the string will automatically be prefixed ans suffixed with '%')	string	None.
LastNameLike	Surname pattern to match against (if no pattern chars are detected the string will automatically be prefixed ans suffixed with '%')	string	None.
Postcode	Users PostCode to match. Can use "," to specify a list of values to match OR ":" to specify a range to search between) e.g. 4000 OR 4000,4002,4004 OR 4000:4004	string	None.
Language	Currently not working!!!	string	None.
LanguageLike	Under development! Currently is used as a pattern to match against spoken languages.	string	None.
DOB	User DOB as a yyyy-mm-dd styled sting. (Likely to be removed)	string	None.
Gender	Select users that match one of the comma separated list of genders (unknown, male, female)	string	None.
Phone	Match clients with given phone number. Will pattern match based on only digits substrings found in pattern (e.g. "07 111" will match "%07%111%")	string	None.
Mobile	Match clients with given mobile phone number. Will pattern match based on only digits substrings found in pattern (e.g. "0044 111" will match "%0400%111%")	string	None.
Limit	Limit to number of rows returned by request (default is 100)	integer	None.
Skip	Number of rows to skip (so we can skip 10 get next 10 etc)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 707,
  "FirstName": "Jack",
  "LastName": "sample string 2",
  "FirstNameLike": "Jac",
  "LastNameLike": "arrow",
  "Postcode": "4000",
  "Language": "French",
  "LanguageLike": "sample string 3",
  "DOB": "1918-06-30",
  "Gender": "male",
  "Phone": "0712345678",
  "Mobile": "0400123456",
  "Limit": 534,
  "Skip": 581
}

application/xml, text/xml

Sample:

<UserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint">
  <DOB>1918-06-30</DOB>
  <FirstName>Jack</FirstName>
  <FirstNameLike>Jac</FirstNameLike>
  <Gender>male</Gender>
  <Id>707</Id>
  <Language>French</Language>
  <LanguageLike>sample string 3</LanguageLike>
  <LastName>sample string 2</LastName>
  <LastNameLike>arrow</LastNameLike>
  <Limit>534</Limit>
  <Mobile>0400123456</Mobile>
  <Phone>0712345678</Phone>
  <Postcode>4000</Postcode>
  <Skip>581</Skip>
</UserRequest>

application/x-www-form-urlencoded

Sample:

[DOB]=samplestring&[Firstname]=Johnny

Response Information

Resource Description

UserReportDetails()

UserReportDetails

Name	Description	Type	Additional 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": 291,
  "userFirstName": "Jack",
  "userSurname": "Sparrow",
  "userPostcode": "1234",
  "userEmail": "jsparrow@notarealdomain.com",
  "userAccountingSystemRef": "sample string 2",
  "userTitle": "Mr",
  "userGender": 1,
  "userDescription": "sample string 3",
  "userDepartment": 303,
  "userLevel": 776,
  "userManagerID": 15,
  "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-04-20T00:12:04.0208752+10:00",
  "userPaylevel": 762
}

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-04-20T00:12:04.0208752+10:00</userDOB>
  <userDepartment>303</userDepartment>
  <userDescription>sample string 3</userDescription>
  <userDisabled>true</userDisabled>
  <userEmail>jsparrow@notarealdomain.com</userEmail>
  <userFirstName>Jack</userFirstName>
  <userGender>1</userGender>
  <userID>291</userID>
  <userLanguages>French,German</userLanguages>
  <userLevel>776</userLevel>
  <userManagerID>15</userManagerID>
  <userMobile>0400123456</userMobile>
  <userNotifyEmail>true</userNotifyEmail>
  <userNotifySMS>true</userNotifySMS>
  <userPaylevel>762</userPaylevel>
  <userPhone>0712345678</userPhone>
  <userPostcode>1234</userPostcode>
  <userQualification>sample string 5</userQualification>
  <userState>NSW</userState>
  <userSurname>Sparrow</userSurname>
  <userTitle>Mr</userTitle>
</UserReportDetails>