GET api/clients/{clientID}/statuses
Gets information about the client's eligibilty status.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientID |
The client's ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns details on the client's eligibility status.
Collection of ClientStatusName | Description | Type | Additional information |
---|---|---|---|
FromDate |
Gets or sets the beginning of the date range covered by this status. |
date |
None. |
ToDate |
Gets or sets the end of the date range covered by this status. If a date is specified, the date is inclusive. If no date is specified, then this status remains indefinitely. |
date |
None. |
IsActive |
Gets or sets whether the client was considered active at this time. |
boolean |
None. |
Status |
Gets or sets the status for the provided date range. |
string |
None. |
Comments |
Gets or sets comments about this status. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "fromDate": "2024-12-23T12:21:20.0038461-07:00", "toDate": "2024-12-23T12:21:20.0038461-07:00", "isActive": true, "status": "sample string 3", "comments": "sample string 4" }, { "fromDate": "2024-12-23T12:21:20.0038461-07:00", "toDate": "2024-12-23T12:21:20.0038461-07:00", "isActive": true, "status": "sample string 3", "comments": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfClientStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <ClientStatus> <Comments>sample string 4</Comments> <FromDate>2024-12-23T12:21:20.0038461-07:00</FromDate> <IsActive>true</IsActive> <Status>sample string 3</Status> <ToDate>2024-12-23T12:21:20.0038461-07:00</ToDate> </ClientStatus> <ClientStatus> <Comments>sample string 4</Comments> <FromDate>2024-12-23T12:21:20.0038461-07:00</FromDate> <IsActive>true</IsActive> <Status>sample string 3</Status> <ToDate>2024-12-23T12:21:20.0038461-07:00</ToDate> </ClientStatus> </ArrayOfClientStatus>