GET Events/Visit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive | boolean |
None. |
|
| IncludeInactive | boolean |
None. |
|
| IncludeDeleted | boolean |
None. |
|
| Match | MatchCriteriaStringType |
None. |
|
| EventIDs | Collection of integer |
None. |
|
| RoleIDs | Collection of integer |
None. |
|
| BusinessUnits | Collection of integer |
None. |
|
| SubType | EventSubType |
None. |
|
| EventRecurrenceID | integer |
None. |
|
| ServiceID | integer |
None. |
|
| PrimaryServiceProviderEntityID | integer |
None. |
|
| PrimaryServiceReceiverEntityID | integer |
None. |
|
| PrimaryGroupEntityID | integer |
None. |
|
| StartDateUtcMin | date |
None. |
|
| StartDateUtcMax | date |
None. |
|
| StopDateUtcMin | date |
None. |
|
| StopDateUtcMax | date |
None. |
|
| Minutes | integer |
None. |
|
| Priority | EventPriority |
None. |
|
| Status | EventStatus |
None. |
|
| StatusReason | string |
None. |
|
| StatusLastUpdatedOnUtcMin | date |
None. |
|
| StatusLastUpdatedOnUtcMax | date |
None. |
|
| StatusLastUpdatedBy | string |
None. |
|
| StatusLastUpdatedByUserID | integer |
None. |
|
| ServiceName | string |
None. |
|
| Comments | string |
None. |
|
| PercentComplete | byte |
None. |
|
| VerificationStatus | EventVerificationStatus |
None. |
|
| CreatedDateUtcMin | date |
None. |
|
| CreatedDateUtcMax | date |
None. |
|
| LastUpdatedDateUtcMin | date |
None. |
|
| LastUpdatedDateUtcMax | date |
None. |
|
| MaxRows | integer |
None. |
|
| ReverseSortOrder | boolean |
None. |
|
| EventShiftCodeID | integer |
None. |
|
| Statuses | Collection of EventStatus |
None. |
|
| IncludeCurrentBedLocation | boolean |
None. |
|
| IncludeCurrentAddressLocation | boolean |
None. |
|
| IncludeNextOccurrence | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of VisitDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EventID | integer |
None. |
|
| BUID | integer |
None. |
|
| SubType | EventSubType |
None. |
|
| EventRecurrenceID | integer |
None. |
|
| EventRecurrenceName | string |
None. |
|
| ServiceID | integer |
None. |
|
| PrimaryServiceProviderEntityID | integer |
None. |
|
| PrimaryServiceProviderEntityName | NameDTO |
None. |
|
| PrimaryServiceReceiverEntityID | integer |
None. |
|
| PrimaryServiceReceiverEntityName | NameDTO |
None. |
|
| PrimaryGroupEntityID | integer |
None. |
|
| PrimaryGroupEntityName | string |
None. |
|
| RoleID | integer |
None. |
|
| RoleName | string |
None. |
|
| SortDateUtc | date |
None. |
|
| StartDateUtc | date |
None. |
|
| StopDateUtc | date |
None. |
|
| Minutes | integer |
None. |
|
| Priority | EventPriority |
None. |
|
| Status | EventStatus |
None. |
|
| StatusReason | string |
None. |
|
| StatusLastUpdatedOnUtc | date |
None. |
|
| StatusLastUpdatedBy | string |
None. |
|
| StatusLastUpdatedByUserID | integer |
None. |
|
| ServiceName | string |
None. |
|
| Comments | string |
None. |
|
| PercentComplete | byte |
None. |
|
| VerificationStatus | EventVerificationStatus |
None. |
|
| Entities | Collection of EntityEventDTO |
None. |
|
| Extensions | Collection of FormDataExtensionDto |
None. |
|
| Forms | Collection of EventFormDTO |
None. |
|
| RecordState | RecordState |
None. |
|
| Created | AuditDataDTO |
None. |
|
| LastUpdated | AuditDataDTO |
None. |
|
| CurrentLocation | string |
None. |
|
| BusinessUnitName | string |
None. |
|
| Recurrence | EventRecurrenceDTO |
None. |
|
| IsOverdue | boolean |
None. |
|
| NextOccurrenceDateUtc | date |
None. |
|
| Summary | string |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-compressed-json
Sample:
Sample not available.