Overview

this is a test api which has been planned for release in Dec 2026

Documents

myTestApiNew.json
Uploaded schema

Environments

Environment Base URL
dev https://dev-api.education.gov.uk/dev/myplannedapi/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 Available to
1 06 December 2026 28 January 2027

Operations

Hide additional information

GET /api/cities - GET

Description
URL template
/api/cities
Show / Hide additional information

Response Codes

Status code Description
200 OK

Example Request

curl -X GET \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities"

GET /api/cities/{cityId}/PointsOfInterest - GET

Description
URL template
/api/cities/{cityId}/PointsOfInterest
Show / Hide additional information

Parameters

Name Type Location Field Description
cityId integer Path Required -

Response Codes

Status code Description
200 OK

Example Request

curl -X GET \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{cityId}/PointsOfInterest"

POST /api/cities/{cityId}/PointsOfInterest - POST

Description
URL template
/api/cities/{cityId}/PointsOfInterest
Show / Hide additional information

Parameters

Name Type Location Field Description
cityId integer Path Required -

Request Model Example

{
  "id": [],
  "name": [],
  "description": []
}

Response Codes

Status code Description
200 OK

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{cityId}/PointsOfInterest" \
  -H "Content-Type: application/json" \
  -d '{
  "id": [],
  "name": [],
  "description": []
}'

DELETE /api/cities/{cityId}/PointsOfInterest/{pointOfInterestId} - DELETE

Description
URL template
/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}
Show / Hide additional information

Parameters

Name Type Location Field Description
cityId integer Path Required -
pointOfInterestId integer Path Required -

Response Codes

Status code Description
200 OK

Example Request

curl -X DELETE \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}"

PATCH /api/cities/{cityId}/PointsOfInterest/{pointOfInterestId} - PATCH

Description
URL template
/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}
Show / Hide additional information

Parameters

Name Type Location Field Description
cityId integer Path Required -
pointOfInterestId integer Path Required -

Request Model Example

{
  "operations": [
    [
      [
        []
      ],
      [
        []
      ],
      [
        []
      ],
      [
        []
      ],
      [
        []
      ]
    ]
  ],
  "contractResolver": []
}

Response Codes

Status code Description
200 OK

Example Request

curl -X PATCH \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}" \
  -H "Content-Type: application/json" \
  -d '{
  "operations": [
    [
      [
        []
      ],
      [
        []
      ],
      [
        []
      ],
      [
        []
      ],
      [
        []
      ]
    ]
  ],
  "contractResolver": []
}'

PUT /api/cities/{cityId}/PointsOfInterest/{pointOfInterestId} - PUT

Description
URL template
/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}
Show / Hide additional information

Parameters

Name Type Location Field Description
cityId integer Path Required -
pointOfInterestId integer Path Required -

Request Model Example

{
  "name": [],
  "description": []
}

Response Codes

Status code Description
200 OK

Example Request

curl -X PUT \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": [],
  "description": []
}'

GET /api/cities/{id} - GET

Description
URL template
/api/cities/{id}
Show / Hide additional information

Parameters

Name Type Location Field Description
id integer Path Required -

Response Codes

Status code Description
200 OK

Example Request

curl -X GET \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{id}"

POST /api/Files - POST

Description
URL template
/api/Files
Show / Hide additional information

Parameters

Name Type Location Field Description
file string Body Optional -

Request Model Example

{
  "file": "example"
}

Response Codes

Status code Description
200 OK

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/Files" \
  -H "Content-Type: multipart/form-data" \
  -d '{
  "file": "example"
}'

GET /api/Files/{fileId} - GET

Description
URL template
/api/Files/{fileId}
Show / Hide additional information

Parameters

Name Type Location Field Description
fileId string Path Required -

Response Codes

Status code Description
200 OK

Example Request

curl -X GET \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/Files/{fileId}"

GET GetPointOfInterest

Description
URL template
/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}
Show / Hide additional information

Parameters

Name Type Location Field Description
cityId integer Path Required -
pointOfInterestId integer Path Required -

Response Codes

Status code Description
200 OK

Example Request

curl -X GET \
  "https://dev-api.education.gov.uk/dev/myplannedapi/1/api/cities/{cityId}/PointsOfInterest/{pointOfInterestId}"
Back to top