POST api/Events
API interface handling generic JSON requests for Events
Request Information
URI Parameters
None.
Body Parameters
EventRequest
EventRequestName | Description | Type | Additional information |
---|---|---|---|
Id |
Request specified appointment by Id |
integer |
None. |
FromDate |
Match appointments from this date onwards |
date |
None. |
ToDate |
Match appoints up to this date |
date |
None. |
Limit |
Limit to number of rows returned by request (default is 100) |
integer |
None. |
Skip |
Number of rows to skip (so we can skip 10 get next 10 etc) |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": 707, "FromDate": "2024-04-25T09:36:04.081211+10:00", "ToDate": "2024-04-25T09:36:04.081211+10:00", "Limit": 534, "Skip": 581 }
application/xml, text/xml
Sample:
<EventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <FromDate>2024-04-25T09:36:04.081211+10:00</FromDate> <Id>707</Id> <Limit>534</Limit> <Skip>581</Skip> <ToDate>2024-04-25T09:36:04.081211+10:00</ToDate> </EventRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
EventReportDetails()
EventReportDetailsName | Description | Type | Additional information |
---|---|---|---|
eventID | integer |
None. |
|
eventName | string |
None. |
|
eventDetails | string |
None. |
|
eventDate_Start | date |
None. |
|
eventDate_End | date |
None. |
|
eventPenalyRates | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "eventID": 291, "eventName": "sample string 2", "eventDetails": "sample string 3", "eventDate_Start": "2024-04-25T09:36:04.081211+10:00", "eventDate_End": "2024-04-25T09:36:04.081211+10:00", "eventPenalyRates": true }
application/xml, text/xml
Sample:
<EventReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <eventDate_End>2024-04-25T09:36:04.081211+10:00</eventDate_End> <eventDate_Start>2024-04-25T09:36:04.081211+10:00</eventDate_Start> <eventDetails>sample string 3</eventDetails> <eventID>291</eventID> <eventName>sample string 2</eventName> <eventPenalyRates>true</eventPenalyRates> </EventReportDetails>