POST Events/Visit?validateOnly={validateOnly}
Add event
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| validateOnly |
Validate data, but don't post it |
boolean |
Default value is False |
Body Parameters
Visit data
VisitDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EventID |
Event ID |
integer |
None. |
| BUID |
BUID |
integer |
None. |
| SubType |
Sub Type |
EventSubType |
None. |
| EventRecurrenceID |
Event Recurrence ID |
integer |
None. |
| EventRecurrenceName |
Event Recurrence Name |
string |
None. |
| ServiceID |
Service ID |
integer |
None. |
| PrimaryServiceProviderEntityID |
Primary Service Provider Entity ID |
integer |
None. |
| PrimaryServiceProviderEntityName |
Primary Service Provider Entity Name |
NameDTO |
None. |
| PrimaryServiceReceiverEntityID |
Primary Service Receiver Entity ID |
integer |
None. |
| PrimaryServiceReceiverEntityName |
Primary Service Receiver Entity Name |
NameDTO |
None. |
| PrimaryGroupEntityID |
Primary Group Entity ID |
integer |
None. |
| PrimaryGroupEntityName |
Primary Group Entity Name |
string |
None. |
| RoleID |
Role ID |
integer |
None. |
| RoleName |
Role Name |
string |
None. |
| SortDateUtc |
Sort Date Utc |
date |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
None. |
| Minutes |
Minutes |
integer |
None. |
| Priority |
Priority |
EventPriority |
None. |
| Status |
Status |
EventStatus |
None. |
| StatusReason |
Status Reason |
string |
None. |
| StatusLastUpdatedOnUtc |
Status Last Updated On Utc |
date |
None. |
| StatusLastUpdatedBy |
Status Last Updated By |
string |
None. |
| StatusLastUpdatedByUserID |
Status Last Updated By User ID |
integer |
None. |
| ServiceName |
Subject |
string |
None. |
| Comments |
Comments |
string |
None. |
| PercentComplete |
Percent Complete |
byte |
None. |
| VerificationStatus |
Verification Status |
EventVerificationStatus |
None. |
| Entities |
Entities |
Collection of EntityEventDTO |
None. |
| Extensions |
Entities |
Collection of FormDataExtensionDto |
None. |
| Forms |
Forms |
Collection of EventFormDTO |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| CurrentLocation |
Current location (bed or address) |
string |
None. |
| BusinessUnitName |
Business Unit Name |
string |
None. |
| Recurrence |
Stores Event Recurrence data |
EventRecurrenceDTO |
None. |
| IsOverdue |
Is Overdue |
boolean |
None. |
| NextOccurrenceDateUtc |
Next Occurrence Date Utc |
date |
None. |
| Summary |
Summary |
string |
None. |
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |