GET api/intakes?name={name}&nameContains={nameContains}&code={code}&codeContains={codeContains}&inactive={inactive}
Get all Intakes optionally filtered by any of the arguments specified in the query string.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name |
Optional case-insensitive filter on Intakes with a name that matches the provided value. |
string |
None. |
| nameContains |
Optional case-insensitive filter on Intakes with a name containing the provided value. |
string |
None. |
| code |
Optional case-insensitive filter on Intakes with a code that matches the provided value. |
string |
None. |
| codeContains |
Optional case-insensitive filter on Intakes with a code containing the provided value. |
string |
None. |
| inactive |
Filter indicating whether to retrieve active or inactive records. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
IntakeDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The primary key of the record in the Hobsons database. |
integer |
None. |
| Name | string |
Required String length: inclusive between 0 and 100 |
|
| Code |
The client system code for the given record. Must be unique across all active and inactive intake records in the database. |
string |
Required String length: inclusive between 0 and 100 |
| IsDefault |
A flag indicating if this record is the default/current Intake. Only one active intake can be set as the default. |
boolean |
Required |
| Position |
Can be used for ordering a collection of records if configured. |
integer |
Range: inclusive between 1 and 99999999 |
| Inactive | boolean |
Required |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| CensusDate | date |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"Name": "sample string 2",
"Code": "sample string 3",
"IsDefault": true,
"Position": 1,
"Inactive": true,
"StartDate": "2024-12-31T04:13:43.2290022+11:00",
"EndDate": "2024-12-31T04:13:43.2290022+11:00",
"CensusDate": "2024-12-31T04:13:43.2290022+11:00"
}