GET api/Clients/{id}
Get details for client specified by Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Id of Client requested |
string |
Required |
Body Parameters
None.
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": 707, "clientFirstName": "Jack", "clientSurname": "Sparrow", "clientSuburb": "Hollywood", "clientPostcode": "1234", "clientLanguagesSpoken": "French,Pirate", "clientPhone": "0712345678", "clientMobile": "0400123456", "clientPackageNum": 534, "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": 581, "clientGender": 1, "clientCountryofBirth": 291, "clientLanguageMain": 303, "clientNDISNumber": "40004000", "clientMedicareIdentifier": "sample string 7", "clientAccountingSystemRef": "sample string 8", "clientDOB": "2024-03-29T08:54:06.8239591+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>291</clientCountryofBirth> <clientDOB>2024-03-29T08:54:06.8239591+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>707</clientID> <clientLanguageMain>303</clientLanguageMain> <clientLanguagesSpoken>French,Pirate</clientLanguagesSpoken> <clientMedicareIdentifier>sample string 7</clientMedicareIdentifier> <clientMobile>0400123456</clientMobile> <clientNDISNumber>40004000</clientNDISNumber> <clientNoteForStaff>sample string 5</clientNoteForStaff> <clientPackageNum>534</clientPackageNum> <clientPhone>0712345678</clientPhone> <clientPostcode>1234</clientPostcode> <clientPreferences>sample string 6</clientPreferences> <clientPropertyName>SS Minnow</clientPropertyName> <clientRegion>581</clientRegion> <clientState>NSW</clientState> <clientStatus>sample string 4</clientStatus> <clientSuburb>Hollywood</clientSuburb> <clientSurname>Sparrow</clientSurname> <clientTitle>Mr</clientTitle> </ClientReportDetails>