REST API for managing cases. A case is the long-lived relationship with a client or household that spans years, multiple applications, and multiple programs.
https://api.example.com/case-managementCases
Manage cases.
▶
GET
/cases
List cases
#
Retrieve a paginated list of cases.
| Name | Type | In | Req | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ▶q | string | query | Search query using field:value syntax. Multiple conditions separated by | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Search query using field:value syntax. Multiple conditions separated by spaces are ANDed together. URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples in this documentation show human-readable syntax for clarity. Syntax
ListsA condition on a list matches when any item matches. That holds for a list of values ( Each condition is checked on its own. Examples
URL Encoding ReferenceWhen manually constructing URLs, encode these characters:
Example: `` | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer | query | Maximum number of items to return (1-100). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| offset | integer | query | Number of items to skip before collecting results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▶sort | string | query | Comma-separated list of fields to sort the response by. Prefix a field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comma-separated list of fields to sort the response by. Prefix a field with URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples below show human-readable syntax for clarity. Which fields a given list endpoint allows is declared in the operation's See Syntax
Examples
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
▶ CaseList
▶ items array[Case] required
active closed▶ members array[CaseMember] Household members associated with this case.
▶ BadRequest
▶ InternalError
▶
POST
/cases
Create a case
#
Create a new case record.
▶ Case
active closed▶ members array[CaseMember] Household members associated with this case.
▶ BadRequest
▶ Conflict
▶ UnprocessableEntity
▶ InternalError
▶
GET
/cases/{caseId}
Get a case
#
Retrieve a single case by identifier.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| caseId | string | path | ✓ | Unique identifier of the case. |
▶ Case
active closed▶ members array[CaseMember] Household members associated with this case.
▶ NotFound
▶ InternalError
▶
PATCH
/cases/{caseId}
Update a case
#
Apply partial updates to an existing case.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| caseId | string | path | ✓ | Unique identifier of the case. |
▶ Case
active closed▶ members array[CaseMember] Household members associated with this case.
▶ BadRequest
▶ NotFound
▶ UnprocessableEntity
▶ InternalError
▶
DELETE
/cases/{caseId}
Delete a case
#
Permanently remove a case record.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| caseId | string | path | ✓ | Unique identifier of the case. |