Vacancy

Update a vacancy

put/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

Request body

statusstring

Updated status

resourceTypestring required
costCentrestring

Cost centre code

Example request

{
  "plannedTime": {
    "timing": [
      {
        "servicePeriod": {
          "start": "10:00:00",
          "end": "18:00:00"
        }
      }
    ]
  },
  "qualifications": [
    {
      "type": "grade",
      "code": {
        "coding": [
          {
            "system": "https://api.patchwork.health/fhir/Grade",
            "code": "1",
            "display": "Foundation Year 1"
          }
        ]
      },
      "priority": "1"
    }
  ],
  "organization": [
    {
      "type": "Organization",
      "identifier": {
        "system": "Patchwork",
        "value": "1"
      },
      "display": "Test Organization",
      "coding": {
        "code": "1"
      }
    },
    {
      "type": "Department",
      "identifier": {
        "system": "Patchwork",
        "value": "2"
      },
      "display": "Test Department",
      "coding": {
        "code": "2"
      }
    },
    {
      "type": "Site",
      "identifier": {
        "system": "Patchwork",
        "value": "3"
      },
      "display": "Test Site",
      "coding": {
        "code": "3"
      }
    }
  ],
  "costCentre": "validcostcentre",
  "reasonCode": {
    "coding": [
      {
        "system": "Patchwork",
        "code": "1",
        "display": "Sickness"
      }
    ]
  },
  "notes": [
    {
      "type": "admin",
      "text": "Note content"
    }
  ]
}

Response

vacancy updated

Changes

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