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://test-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/1

You need to sign in to subscribe to an API environment or view your existing subscriptions.

Sign in here using GOV.UK One Login

Current release

Release name Available from
1.0 12 September 2024

Operations

Show additional information

GET Download

Description

Downloads a file specified by the file name

URL template
/Download/{filename}
Show / Hide additional information

Parameters

Name Type Location Field Description
filename string Path Required Please supply the filename for download

Response Codes

Status code Description
200 The OK response

Example Request

curl -X GET \
  "https://test-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/1/Download/{filename}"

GET Echo-Get

Description

Simple GET endpoint which echos all the requested data into JSON format

URL template
/Echo-Get
Show / Hide additional information

Response Codes

Status code Description
200 The OK response

Example Request

curl -X GET \
  "https://test-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/1/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
Show / Hide additional information

Response Codes

Status code Description
200 The OK response

Example Request

curl -X POST \
  "https://test-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/1/Echo-Post"

GET List

Description

Lists all files which have been uploaded

URL template
/List
Show / Hide additional information

Response Codes

Status code Description
200 The OK response

Example Request

curl -X GET \
  "https://test-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/1/List"

POST Upload

Description

Uploads a file

URL template
/Upload
Show / Hide additional information

Response Codes

Status code Description
200 The OK response

Example Request

curl -X POST \
  "https://test-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/1/Upload" \
  -H "Content-Type: multipart/form-data;"
Back to top