Vacancy

Retrieve a vacancy

get/nhsapi/v1/Vacancy/{id}

Request

  • Base URL: https://www.example.com
  • URL: https://www.example.com/nhsapi/v1/Vacancy/{id}
  • Auth: none declared

Path parameters

idunknown required

Vacancy ID

Headers

X-External-Account-Tokenstring

External account token for authentication

Response

vacancy retrieved

idstring
resourceTypestring
statusstring

Example response

{
  "id": "a0521313-606c-456a-887f-bad4758bbbf4",
  "resourceType": "Vacancy",
  "meta": {
    "profile": "https://api.patchwork.health/Vacancy"
  },
  "status": "requested",
  "organization": [
    {
      "type": "Organization",
      "identifier": {
        "system": "Patchwork",
        "value": "1"
      },
      "display": "Unique Test Hospital NHS API",
      "coding": {
        "code": "1"
      }
    }
  ],
  "notes": [
    {
      "type": "admin",
      "text": "Administrative note text"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.