GET Setup/Allergy
Get allergies 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. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| AllergyIDs |
Filter by AllergyIDs |
Collection of integer |
None. |
| AllergyTableID |
Filter by AllergyTableID |
integer |
None. |
| AllergyType |
Filter by AllergyType |
AllergyType |
None. |
| AllergyCode |
Filter by AllergyCode |
string |
None. |
| AllergyDescription |
Filter by AllergyDescription |
string |
None. |
| ExceptAllergyID |
Filter out by AllergyID |
integer |
None. |
| MaxRows |
Limit number of rows |
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. |
Body Parameters
None.
Response Information
Resource Description
List of AllergyDTOs
Collection of AllergyDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| AllergyID |
Allergy ID |
integer |
None. |
| AllergyTableID |
Allergy Table ID |
integer |
None. |
| AllergyType |
Allergy Type |
AllergyType |
None. |
| AllergyCode |
Allergy Code |
string |
None. |
| AllergyDescription |
Allergy Description |
string |
None. |
| Props |
Props |
Collection of Object |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| Summary |
Summary |
string |
None. |