GET Clients/CarePlan
Get clientCarePlans from criteria
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
IncludeError |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
ClientCarePlanIDs |
Filter by ClientCarePlanIDs |
Collection of integer |
None. |
ClientID |
Filter by ClientID |
integer |
None. |
ClientIDs |
Filter by ClientIDs |
Collection of integer |
None. |
CarePlanID |
Filter by CarePlanID |
integer |
None. |
StartDateUtcMin |
Filter by StartDateUtcMin |
date |
None. |
StartDateUtcMax |
Filter by StartDateUtcMax |
date |
None. |
StopDateUtcMin |
Filter by StopDateUtcMin |
date |
None. |
StopDateUtcMax |
Filter by StopDateUtcMax |
date |
None. |
EntryStartDateUtcMin |
Filter by EntryStartDateUtcMin |
date |
None. |
EntryStartDateUtcMax |
Filter by EntryStartDateUtcMax |
date |
None. |
RecordState |
Filter by RecordState |
ClinicalRecordState |
None. |
CreatedByUserID |
Filter by CreatedByUserID |
integer |
None. |
LastUpdatedByUserID |
Filter by LastUpdatedByUserID |
integer |
None. |
CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
IncludePayload |
Include payload |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ClientCarePlanDTOs
IHttpActionResultNone.