Overview
This demonstration API is provided to show the content available for a DfE service which is advertised on Find and Use an API but hosted elsewhere.
Documents
- FaUAPI-Demo-Function.json
- Uploaded schema
Who can use this API
The API is available for anyone to use
Service level
This is an example service and has no SLA
Technologies
C# .NET
Environments
| Environment | Base URL |
|---|---|
| dev | https://s197d01-fauapi-demo-fnc.azurewebsites.net/api |
You need to sign in to subscribe to an API environment or view your existing subscriptions.
Current release
| Release name | Available from |
|---|---|
| 1.0 | 11 September 2024 |
Operations
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://{{baseURL}}/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://{{baseURL}}/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://{{baseURL}}/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://{{baseURL}}/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://{{baseURL}}/Upload" \
-H "Content-Type: multipart/form-data;"Back to top