Overview
This demonstration API is provided to allow any user to test the process of subscribing and connecting to an API using the Find and Use an API service. It is secured using a subscription key and native OAuth application flow
Documents
- FaUAPI-Demo-Function.json
- Uploaded schema
Who can use this API
Anyone who signs in to the Find and Use an API service using a GOV.UK One Login account.
Service level
This is an example service and has no SLA
Technologies
C# .NET
Environments
| Environment | Base URL |
|---|---|
| Dev | https://api.education.gov.uk/dev/fauapi-demo-nativeoauth |
| Live | https://api.education.gov.uk/fauapi-demo-nativeoauth |
You need to sign in to subscribe to an API environment.
Current release
| Release name | Available from |
|---|---|
| 1.0 | 13th September 2024 |
Operations
GET Download
- Description
-
Downloads a file specified by the file name
- URL template
- /Download/{filename}
GET Echo-Get
- Description
-
Simple GET endpoint which echos all the requested data into JSON format
- URL template
- /Echo-Get
POST Echo-Post
- Description
-
Simple POST endpoint which echos all the requested data into JSON format including a plain text body
- URL template
- /Echo-Post
GET List
- Description
-
Lists all files which have been uploaded
- URL template
- /List
POST Upload
- Description
-
Uploads a file
- URL template
- /Upload
Back to top