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