How do I call the calendar_events endpoints over HTTP?
Table of Contents
- 1. Endpoints
- 1.1.
GET /api/v1/reference-data/calendar_events - 1.2.
GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000 - 1.3.
POST /api/v1/reference-data/calendar_events/get-many - 1.4.
POST /api/v1/reference-data/calendar_events - 1.5.
PUT /api/v1/reference-data/calendar_events - 1.6.
POST /api/v1/reference-data/calendar_events/put-many - 1.7.
DELETE /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000 - 1.8.
POST /api/v1/reference-data/calendar_events/delete-many - 1.9.
GET /api/v1/reference-data/calendar_events/by-calendar-code/__none__ - 1.10.
GET /api/v1/reference-data/calendar_events/by-diary-entry-type/__none__ - 1.11.
GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions - 1.12.
GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions/0
- 1.1.
This file documents the calendar_events resource over HTTP, one section per endpoint. Every section exports its own Hurl file into projects/ores.http/scripts/library/. Running a file sends that one request, so a failure names the endpoint it came from.
1. Endpoints
1.1. GET /api/v1/reference-data/calendar_events
List calendar events. It needs a session.
It forwards to refdata.v1.calendar_events.list.
The request is:
GET /api/v1/reference-data/calendar_events
GET {{base_url}}/api/v1/reference-data/calendar_events
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.2. GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000
Get one calendar event. It needs a session.
It forwards to refdata.v1.calendar_events.get.
The request is:
GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000
GET {{base_url}}/api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.3. POST /api/v1/reference-data/calendar_events/get-many
Get many calendar events. It needs a session.
It forwards to refdata.v1.calendar_events.get_many.
The request is:
POST /api/v1/reference-data/calendar_events/get-many
POST {{base_url}}/api/v1/reference-data/calendar_events/get-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.4. POST /api/v1/reference-data/calendar_events
Create one calendar event. It needs a session.
It forwards to refdata.v1.calendar_events.put.
The request is:
POST /api/v1/reference-data/calendar_events
POST {{base_url}}/api/v1/reference-data/calendar_events
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.5. PUT /api/v1/reference-data/calendar_events
Replace one calendar event. It needs a session.
It forwards to refdata.v1.calendar_events.put.
The request is:
PUT /api/v1/reference-data/calendar_events
PUT {{base_url}}/api/v1/reference-data/calendar_events
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.6. POST /api/v1/reference-data/calendar_events/put-many
Write many calendar events. It needs a session.
It forwards to refdata.v1.calendar_events.put_many.
The request is:
POST /api/v1/reference-data/calendar_events/put-many
POST {{base_url}}/api/v1/reference-data/calendar_events/put-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.7. DELETE /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000
Delete one calendar event. It needs a session.
It forwards to refdata.v1.calendar_events.delete.
The request is:
DELETE /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000
DELETE {{base_url}}/api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.8. POST /api/v1/reference-data/calendar_events/delete-many
Delete many calendar events. It needs a session.
It forwards to refdata.v1.calendar_events.delete_many.
The request is:
POST /api/v1/reference-data/calendar_events/delete-many
POST {{base_url}}/api/v1/reference-data/calendar_events/delete-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.9. GET /api/v1/reference-data/calendar_events/by-calendar-code/__none__
List the calendar events that reference one calendar code. It needs a session.
It forwards to refdata.v1.calendar_events.list_by_calendar_code.
The request is:
GET /api/v1/reference-data/calendar_events/by-calendar-code/__none__
GET {{base_url}}/api/v1/reference-data/calendar_events/by-calendar-code/__none__
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.10. GET /api/v1/reference-data/calendar_events/by-diary-entry-type/__none__
List the calendar events that reference one diary entry type. It needs a session.
It forwards to refdata.v1.calendar_events.list_by_diary_entry_type.
The request is:
GET /api/v1/reference-data/calendar_events/by-diary-entry-type/__none__
GET {{base_url}}/api/v1/reference-data/calendar_events/by-diary-entry-type/__none__
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.11. GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions
List the recorded versions of one calendar event. It needs a session.
It forwards to refdata.v1.calendar_events_versions.list.
The request is:
GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions
GET {{base_url}}/api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.12. GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions/0
Get one recorded version of one calendar event. It needs a session.
It forwards to refdata.v1.calendar_events_versions.get.
The request is:
GET /api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions/0
GET {{base_url}}/api/v1/reference-data/calendar_events/00000000-0000-0000-0000-000000000000/versions/0
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200