How do I call the calendar_exceptions endpoints over HTTP?
Table of Contents
- 1. Endpoints
- 1.1.
GET /api/v1/reference-data/calendar_exceptions - 1.2.
GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000 - 1.3.
POST /api/v1/reference-data/calendar_exceptions/get-many - 1.4.
POST /api/v1/reference-data/calendar_exceptions - 1.5.
PUT /api/v1/reference-data/calendar_exceptions - 1.6.
POST /api/v1/reference-data/calendar_exceptions/put-many - 1.7.
DELETE /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000 - 1.8.
POST /api/v1/reference-data/calendar_exceptions/delete-many - 1.9.
GET /api/v1/reference-data/calendar_exceptions/by-calendar-code/__none__ - 1.10.
GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions - 1.11.
GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions/0
- 1.1.
This file documents the calendar_exceptions 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_exceptions
List calendar exceptions. It needs a session.
It forwards to refdata.v1.calendar_exceptions.list.
The request is:
GET /api/v1/reference-data/calendar_exceptions
GET {{base_url}}/api/v1/reference-data/calendar_exceptions
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.2. GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000
Get one calendar exception. It needs a session.
It forwards to refdata.v1.calendar_exceptions.get.
The request is:
GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000
GET {{base_url}}/api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.3. POST /api/v1/reference-data/calendar_exceptions/get-many
Get many calendar exceptions. It needs a session.
It forwards to refdata.v1.calendar_exceptions.get_many.
The request is:
POST /api/v1/reference-data/calendar_exceptions/get-many
POST {{base_url}}/api/v1/reference-data/calendar_exceptions/get-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.4. POST /api/v1/reference-data/calendar_exceptions
Create one calendar exception. It needs a session.
It forwards to refdata.v1.calendar_exceptions.put.
The request is:
POST /api/v1/reference-data/calendar_exceptions
POST {{base_url}}/api/v1/reference-data/calendar_exceptions
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.5. PUT /api/v1/reference-data/calendar_exceptions
Replace one calendar exception. It needs a session.
It forwards to refdata.v1.calendar_exceptions.put.
The request is:
PUT /api/v1/reference-data/calendar_exceptions
PUT {{base_url}}/api/v1/reference-data/calendar_exceptions
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.6. POST /api/v1/reference-data/calendar_exceptions/put-many
Write many calendar exceptions. It needs a session.
It forwards to refdata.v1.calendar_exceptions.put_many.
The request is:
POST /api/v1/reference-data/calendar_exceptions/put-many
POST {{base_url}}/api/v1/reference-data/calendar_exceptions/put-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.7. DELETE /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000
Delete one calendar exception. It needs a session.
It forwards to refdata.v1.calendar_exceptions.delete.
The request is:
DELETE /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000
DELETE {{base_url}}/api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.8. POST /api/v1/reference-data/calendar_exceptions/delete-many
Delete many calendar exceptions. It needs a session.
It forwards to refdata.v1.calendar_exceptions.delete_many.
The request is:
POST /api/v1/reference-data/calendar_exceptions/delete-many
POST {{base_url}}/api/v1/reference-data/calendar_exceptions/delete-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.9. GET /api/v1/reference-data/calendar_exceptions/by-calendar-code/__none__
List the calendar exceptions that reference one calendar code. It needs a session.
It forwards to refdata.v1.calendar_exceptions.list_by_calendar_code.
The request is:
GET /api/v1/reference-data/calendar_exceptions/by-calendar-code/__none__
GET {{base_url}}/api/v1/reference-data/calendar_exceptions/by-calendar-code/__none__
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.10. GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions
List the recorded versions of one calendar exception. It needs a session.
It forwards to refdata.v1.calendar_exceptions_versions.list.
The request is:
GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions
GET {{base_url}}/api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.11. GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions/0
Get one recorded version of one calendar exception. It needs a session.
It forwards to refdata.v1.calendar_exceptions_versions.get.
The request is:
GET /api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions/0
GET {{base_url}}/api/v1/reference-data/calendar_exceptions/00000000-0000-0000-0000-000000000000/versions/0
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200