Overview
This API exists solely for demonstration purposes.
Documents
- FaUAPI-Example-API.json
- Uploaded schema
Environments
| Environment | Base URL |
|---|---|
| live | https://dev-api.education.gov.uk/example-ukrlp/1 |
You need to sign in to subscribe to an API environment or view your existing subscriptions.
Current release
| Release name | Available from |
|---|---|
| alpha | 31 March 2026 |
Operations
GET Basic GET request
- Description
-
Provides a sample piece of text in response to a GET request. This operation does not require an Authorization header.
- URL template
- /getInformation
Show / Hide additional information
Response Codes
| Status code | Description |
|---|---|
| 200 | Successful response with information |
Example Request
curl -X GET \
"https://dev-api.education.gov.uk/example-ukrlp/1/getInformation"GET Basic GET request requiring OAuth authentication
- Description
-
An OAuth protected operation. Provides a sample piece of text in response to a GET request when a suitable Bearer token is included in the Authorization header.
- URL template
- /getInformationOauth
Show / Hide additional information
Response Codes
| Status code | Description |
|---|---|
| 200 | Successful response with OAuth-protected information |
Example Request
curl -X GET \
"https://dev-api.education.gov.uk/example-ukrlp/1/getInformationOauth"POST Basic POST request
- Description
-
Provides a sample piece of text in response to a POST request. This operation does not require an Authorization header.
- URL template
- /postInformation
Show / Hide additional information
Response Codes
| Status code | Description |
|---|---|
| 200 | Successful response with information |
Example Request
curl -X POST \
"https://dev-api.education.gov.uk/example-ukrlp/1/postInformation"Back to top