GET api/events/{Id}
Get event by event Id.
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
(Required) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Event| Name | Description | Type | Additional information |
|---|---|---|---|
| EventId |
Event Id. Primary key of the events table. |
integer |
None. |
| PropertyId |
Property Id. See the GET api/properties/{propertyId} route to get the property data. |
integer |
None. |
| CalEventTypeId |
Calendar Event Type Id. See the GET api/eventtypes route to get the event type data. |
integer |
None. |
| EventName |
Event Name. |
string |
None. |
| EventNotes |
Event Notes. |
string |
None. |
| CalendarId |
Calendar Id. See the GET api/calendars/{id} route to get the calendar data. |
integer |
None. |
| EventStartDtm |
Event Start Date Time. |
date |
None. |
| EventEndDtm |
Event End Date Time. |
date |
None. |
Response Formats
application/json, text/json
Sample:
{
"EventId": 1,
"PropertyId": 2,
"CalEventTypeId": 1,
"EventName": "sample string 3",
"EventNotes": "sample string 4",
"CalendarId": 5,
"EventStartDtm": "2025-12-24T05:23:47.6152146-05:00",
"EventEndDtm": "2025-12-24T05:23:47.6152146-05:00"
}
Internal Error Codes
-
106: ResourceNotFound
(The requested resource was not found., NotFound) -
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest) -
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest) -
199: UnknownError
(Internal server error., InternalServerError) -
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)