POST api/Clients
API interface handling generic JSON requests for Clients (limit for maximum records returned defaults to 200)
Request Information
URI Parameters
None.
Body Parameters
ClientRequest
ClientRequestName | Description | Type | Additional information |
---|---|---|---|
Id |
Match Client by specific Id |
integer |
None. |
FirstName |
Match clients with firstname (can match a s single "name" OR list (i.e. "name,name,...") OR range of names (i.e. "name:name")) |
string |
None. |
Surname |
Match clients with surname (can match a s single "name" OR list (i.e. "name,name,...") OR range of names (i.e. "name:name")) |
string |
None. |
FirstNameLike |
Match clients with first matching given pattern |
string |
None. |
LastNameLike |
Match clients with surname matching given pattern |
string |
None. |
Postcode |
Match clients with postcode (can match a s single "code" OR list (i.e. "code,code,...") OR range of names (i.e. "code:code")) |
string |
None. |
MainLanguage |
Get clients that have ABS code for Language as the main language spoken at home |
integer |
None. |
LanguageLike |
Matches clients that the ability to speak language (matching pattern) |
string |
None. |
DOB |
Match clients with specified date of birth |
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. |
Gender |
Retrieve clients with gender specified as one of a comma separated list (unknown,male,female) |
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
{ "Id": 707, "FirstName": "Jack", "Surname": "Sparrow", "FirstNameLike": "Jac", "LastNameLike": "arrow", "Postcode": "4000", "MainLanguage": 534, "LanguageLike": "sample string 3", "DOB": "1918-06-30", "Phone": "0712345678", "Gender": "male", "Mobile": "0400123456", "Limit": 581, "Skip": 291 }
application/xml, text/xml
<ClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <DOB>1918-06-30</DOB> <FirstName>Jack</FirstName> <FirstNameLike>Jac</FirstNameLike> <Gender>male</Gender> <Id>707</Id> <LanguageLike>sample string 3</LanguageLike> <LastNameLike>arrow</LastNameLike> <Limit>581</Limit> <MainLanguage>534</MainLanguage> <Mobile>0400123456</Mobile> <Phone>0712345678</Phone> <Postcode>4000</Postcode> <Skip>291</Skip> <Surname>Sparrow</Surname> </ClientRequest>
application/x-www-form-urlencoded
[LastName]=Thomas&[Firstname]=Johnny
Response Information
Resource Description
ClientReportDetails()
ClientReportDetailsName | Description | Type | Additional information |
---|---|---|---|
clientID |
Unique Client Identifier |
integer |
None. |
clientFirstName |
Clients first name(s) |
string |
None. |
clientSurname |
Clients surname |
string |
None. |
clientSuburb |
Clients suburb |
string |
None. |
clientPostcode |
Client postcode |
string |
None. |
clientLanguagesSpoken |
Languages spoken in clients household |
string |
None. |
clientPhone |
Clients Phone number |
string |
None. |
clientMobile |
Clients Mobile number |
string |
None. |
clientPackageNum |
Clients Package number |
integer |
None. |
clientTitle |
Clients Title |
string |
None. |
clientDescription |
Client Description |
string |
None. |
clientPropertyName |
Clients Property Name |
string |
None. |
clientAddress |
Clients street Address |
string |
None. |
clientState |
Clients State of residence |
string |
None. |
clientCoordinates |
Clients (GPS) Coordinates |
string |
None. |
clientEmail |
Clients contact email address |
string |
None. |
clientExclusions |
Clients service exclusions |
string |
None. |
clientStatus |
Client current status |
string |
None. |
clientDisabled |
Client is disabled |
boolean |
None. |
clientNoteForStaff |
Note for staff re: Client care |
string |
None. |
clientPreferences |
Clients carer preferences |
string |
None. |
clientRegion |
Clients region |
integer |
None. |
clientGender |
Clients Gender |
integer |
None. |
clientCountryofBirth |
Clients Country of Birth |
integer |
None. |
clientLanguageMain |
ABS Code for main language spoken in home |
integer |
None. |
clientNDISNumber |
Clients NDIS reference number |
string |
None. |
clientMedicareIdentifier |
Clients medicare No. |
string |
None. |
clientAccountingSystemRef |
Accounting system reference code |
string |
None. |
clientDOB |
Clients Date of Birth |
date |
None. |
Response Formats
application/json, text/json
{ "clientID": 303, "clientFirstName": "Jack", "clientSurname": "Sparrow", "clientSuburb": "Hollywood", "clientPostcode": "1234", "clientLanguagesSpoken": "French,Pirate", "clientPhone": "0712345678", "clientMobile": "0400123456", "clientPackageNum": 776, "clientTitle": "Mr", "clientDescription": "sample string 2", "clientPropertyName": "SS Minnow", "clientAddress": "123 Reallylong St", "clientState": "NSW", "clientCoordinates": "-27.58102,145.090337", "clientEmail": "jsparrow@notarealdomain.com", "clientExclusions": "sample string 3", "clientStatus": "sample string 4", "clientDisabled": true, "clientNoteForStaff": "sample string 5", "clientPreferences": "sample string 6", "clientRegion": 15, "clientGender": 1, "clientCountryofBirth": 762, "clientLanguageMain": 815, "clientNDISNumber": "40004000", "clientMedicareIdentifier": "sample string 7", "clientAccountingSystemRef": "sample string 8", "clientDOB": "2024-03-29T17:44:37.9725821+11:00" }
application/xml, text/xml
<ClientReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <clientAccountingSystemRef>sample string 8</clientAccountingSystemRef> <clientAddress>123 Reallylong St</clientAddress> <clientCoordinates>-27.58102,145.090337</clientCoordinates> <clientCountryofBirth>762</clientCountryofBirth> <clientDOB>2024-03-29T17:44:37.9725821+11:00</clientDOB> <clientDescription>sample string 2</clientDescription> <clientDisabled>true</clientDisabled> <clientEmail>jsparrow@notarealdomain.com</clientEmail> <clientExclusions>sample string 3</clientExclusions> <clientFirstName>Jack</clientFirstName> <clientGender>1</clientGender> <clientID>303</clientID> <clientLanguageMain>815</clientLanguageMain> <clientLanguagesSpoken>French,Pirate</clientLanguagesSpoken> <clientMedicareIdentifier>sample string 7</clientMedicareIdentifier> <clientMobile>0400123456</clientMobile> <clientNDISNumber>40004000</clientNDISNumber> <clientNoteForStaff>sample string 5</clientNoteForStaff> <clientPackageNum>776</clientPackageNum> <clientPhone>0712345678</clientPhone> <clientPostcode>1234</clientPostcode> <clientPreferences>sample string 6</clientPreferences> <clientPropertyName>SS Minnow</clientPropertyName> <clientRegion>15</clientRegion> <clientState>NSW</clientState> <clientStatus>sample string 4</clientStatus> <clientSuburb>Hollywood</clientSuburb> <clientSurname>Sparrow</clientSurname> <clientTitle>Mr</clientTitle> </ClientReportDetails>