GET api/tblClients/GetClient/{param1}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
param1

string

Required

Body Parameters

None.

Response Information

Resource Description

tblClient
NameDescriptionTypeAdditional information
clientID

integer

None.

clientRefer

string

None.

clientRefNumber

string

None.

clientReferrerNum

integer

None.

clientPackageNum

integer

None.

clientTitle

string

None.

clientFullName

string

None.

clientFirstname

string

None.

clientSurname

string

None.

clientDescription

string

None.

clientCompanyID

integer

None.

clientDOB

date

None.

clientPropertyName

string

None.

clientAddress

string

None.

clientSuburb

string

None.

clientPostcode

string

None.

clientState

string

None.

clientCoordinates

string

None.

clientEmail

string

None.

clientPhone

string

None.

clientMobile

string

None.

clientDateModified

date

None.

clientCareLevel1

integer

None.

clientCareLevel2

integer

None.

clientCareLevel3

integer

None.

clientCareLevel4

integer

None.

clientCareLevel5

integer

None.

clientExclusions

string

None.

clientStatus1

string

None.

clientSystemAccess

boolean

None.

clientSystemPassword

string

None.

clientAccountingSystemRef

string

None.

clientDisabled

boolean

None.

clientNotesForStaff

string

None.

clientPreferences

string

None.

clientNonChargeable

boolean

None.

clientChargeableKMDefault

integer

None.

clientKMsFromOffice

integer

None.

clientBalance

decimal number

None.

clientBudgetStructure1

string

None.

clientStatementsEnabled

boolean

None.

clientMedicareIdentifier

string

None.

clientLanguagesSpoken

string

None.

clientPackageSchedule

string

None.

clientCarePlanStructure

string

None.

clientStatementDateLocked

date

None.

clientPrefname

string

None.

clientDVAFileNumber

string

None.

clientDVAPlanID

string

None.

clientCaseManager

integer

None.

clientReportingSettings1

string

None.

clientBalance_Contingency

decimal number

None.

clientBillingGroup

integer

None.

clientSchedulingUser

integer

None.

clientSupportPlan1

string

None.

clientBankAccountDetails

string

None.

clientBillingAddress

string

None.

clientSettings_ABF

string

None.

clientChargeableMINSDefault

integer

None.

clientRegion

integer

None.

clientCustomSettingsForm1

string

None.

clientCustomSettingsFormEmergency

string

None.

clientGender

integer

None.

clientExcludeFromDEX

integer

None.

clientCountryofBirth

integer

None.

clientLanguageMain

integer

None.

clientNDISNumber

string

None.

Response Formats

application/json, text/json

Sample:
{
  "clientID": 1,
  "clientRefer": "sample string 2",
  "clientRefNumber": "sample string 3",
  "clientReferrerNum": 1,
  "clientPackageNum": 1,
  "clientTitle": "sample string 4",
  "clientFullName": "sample string 5",
  "clientFirstname": "sample string 6",
  "clientSurname": "sample string 7",
  "clientDescription": "sample string 8",
  "clientCompanyID": 1,
  "clientDOB": "2024-10-15T18:18:30.2191904-07:00",
  "clientPropertyName": "sample string 9",
  "clientAddress": "sample string 10",
  "clientSuburb": "sample string 11",
  "clientPostcode": "sample string 12",
  "clientState": "sample string 13",
  "clientCoordinates": "sample string 14",
  "clientEmail": "sample string 15",
  "clientPhone": "sample string 16",
  "clientMobile": "sample string 17",
  "clientDateModified": "2024-10-15T18:18:30.2191904-07:00",
  "clientCareLevel1": 1,
  "clientCareLevel2": 1,
  "clientCareLevel3": 1,
  "clientCareLevel4": 1,
  "clientCareLevel5": 1,
  "clientExclusions": "sample string 18",
  "clientStatus1": "sample string 19",
  "clientSystemAccess": true,
  "clientSystemPassword": "sample string 20",
  "clientAccountingSystemRef": "sample string 21",
  "clientDisabled": true,
  "clientNotesForStaff": "sample string 22",
  "clientPreferences": "sample string 23",
  "clientNonChargeable": true,
  "clientChargeableKMDefault": 1,
  "clientKMsFromOffice": 1,
  "clientBalance": 1.1,
  "clientBudgetStructure1": "sample string 24",
  "clientStatementsEnabled": true,
  "clientMedicareIdentifier": "sample string 25",
  "clientLanguagesSpoken": "sample string 26",
  "clientPackageSchedule": "sample string 27",
  "clientCarePlanStructure": "sample string 28",
  "clientStatementDateLocked": "2024-10-15T18:18:30.2348606-07:00",
  "clientPrefname": "sample string 29",
  "clientDVAFileNumber": "sample string 30",
  "clientDVAPlanID": "sample string 31",
  "clientCaseManager": 1,
  "clientReportingSettings1": "sample string 32",
  "clientBalance_Contingency": 1.1,
  "clientBillingGroup": 1,
  "clientSchedulingUser": 1,
  "clientSupportPlan1": "sample string 33",
  "clientBankAccountDetails": "sample string 34",
  "clientBillingAddress": "sample string 35",
  "clientSettings_ABF": "sample string 36",
  "clientChargeableMINSDefault": 1,
  "clientRegion": 1,
  "clientCustomSettingsForm1": "sample string 37",
  "clientCustomSettingsFormEmergency": "sample string 38",
  "clientGender": 1,
  "clientExcludeFromDEX": 1,
  "clientCountryofBirth": 1,
  "clientLanguageMain": 1,
  "clientNDISNumber": "sample string 39"
}

application/xml, text/xml

Sample:
<tblClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.WebAPI">
  <clientAccountingSystemRef>sample string 21</clientAccountingSystemRef>
  <clientAddress>sample string 10</clientAddress>
  <clientBalance>1.1</clientBalance>
  <clientBalance_Contingency>1.1</clientBalance_Contingency>
  <clientBankAccountDetails>sample string 34</clientBankAccountDetails>
  <clientBillingAddress>sample string 35</clientBillingAddress>
  <clientBillingGroup>1</clientBillingGroup>
  <clientBudgetStructure1>sample string 24</clientBudgetStructure1>
  <clientCareLevel1>1</clientCareLevel1>
  <clientCareLevel2>1</clientCareLevel2>
  <clientCareLevel3>1</clientCareLevel3>
  <clientCareLevel4>1</clientCareLevel4>
  <clientCareLevel5>1</clientCareLevel5>
  <clientCarePlanStructure>sample string 28</clientCarePlanStructure>
  <clientCaseManager>1</clientCaseManager>
  <clientChargeableKMDefault>1</clientChargeableKMDefault>
  <clientChargeableMINSDefault>1</clientChargeableMINSDefault>
  <clientCompanyID>1</clientCompanyID>
  <clientCoordinates>sample string 14</clientCoordinates>
  <clientCountryofBirth>1</clientCountryofBirth>
  <clientCustomSettingsForm1>sample string 37</clientCustomSettingsForm1>
  <clientCustomSettingsFormEmergency>sample string 38</clientCustomSettingsFormEmergency>
  <clientDOB>2024-10-15T18:18:30.2191904-07:00</clientDOB>
  <clientDVAFileNumber>sample string 30</clientDVAFileNumber>
  <clientDVAPlanID>sample string 31</clientDVAPlanID>
  <clientDateModified>2024-10-15T18:18:30.2191904-07:00</clientDateModified>
  <clientDescription>sample string 8</clientDescription>
  <clientDisabled>true</clientDisabled>
  <clientEmail>sample string 15</clientEmail>
  <clientExcludeFromDEX>1</clientExcludeFromDEX>
  <clientExclusions>sample string 18</clientExclusions>
  <clientFirstname>sample string 6</clientFirstname>
  <clientFullName>sample string 5</clientFullName>
  <clientGender>1</clientGender>
  <clientID>1</clientID>
  <clientKMsFromOffice>1</clientKMsFromOffice>
  <clientLanguageMain>1</clientLanguageMain>
  <clientLanguagesSpoken>sample string 26</clientLanguagesSpoken>
  <clientMedicareIdentifier>sample string 25</clientMedicareIdentifier>
  <clientMobile>sample string 17</clientMobile>
  <clientNDISNumber>sample string 39</clientNDISNumber>
  <clientNonChargeable>true</clientNonChargeable>
  <clientNotesForStaff>sample string 22</clientNotesForStaff>
  <clientPackageNum>1</clientPackageNum>
  <clientPackageSchedule>sample string 27</clientPackageSchedule>
  <clientPhone>sample string 16</clientPhone>
  <clientPostcode>sample string 12</clientPostcode>
  <clientPreferences>sample string 23</clientPreferences>
  <clientPrefname>sample string 29</clientPrefname>
  <clientPropertyName>sample string 9</clientPropertyName>
  <clientRefNumber>sample string 3</clientRefNumber>
  <clientRefer>sample string 2</clientRefer>
  <clientReferrerNum>1</clientReferrerNum>
  <clientRegion>1</clientRegion>
  <clientReportingSettings1>sample string 32</clientReportingSettings1>
  <clientSchedulingUser>1</clientSchedulingUser>
  <clientSettings_ABF>sample string 36</clientSettings_ABF>
  <clientState>sample string 13</clientState>
  <clientStatementDateLocked>2024-10-15T18:18:30.2348606-07:00</clientStatementDateLocked>
  <clientStatementsEnabled>true</clientStatementsEnabled>
  <clientStatus1>sample string 19</clientStatus1>
  <clientSuburb>sample string 11</clientSuburb>
  <clientSupportPlan1>sample string 33</clientSupportPlan1>
  <clientSurname>sample string 7</clientSurname>
  <clientSystemAccess>true</clientSystemAccess>
  <clientSystemPassword>sample string 20</clientSystemPassword>
  <clientTitle>sample string 4</clientTitle>
</tblClient>