PUT|PATCH /trainees/{trainee_id}/placements/{placement_id}

Updates an existing placement for this trainee.

Request

PUT /api/v0.1/trainees/{trainee_id}/placements/{placement_id}

or

PATCH /api/v0.1/trainees/{trainee_id}/placements/{placement_id}

Parameters

Parameter	In	Type	Required	Description
trainee_id	path	string	true	The unique ID of the trainee
placement_id	path	string	true	The unique ID of the placement

Request body

Placement details

• data:

  Placement object

Example request body

    {
      "data": {
        "urn": "137523",
        "name": "Wellsway School"
      }
    }
    

Possible responses

HTTP 200 - A placement

    {
      "data": {
        "urn": null,
        "name": "Wellsway School",
        "address": null,
        "postcode": null,
        "created_at": "2024-03-19T22:23:48.619Z",
        "updated_at": "2024-03-19T22:23:48.619Z"
      }
    }
    

HTTP 404 - Not found

    {
      "errors": [
        {
          "error": "NotFound",
          "message": "Placement(s) not found"
        }
      ]
    }
    

HTTP 401 - Unauthorized

    {
      "error": "Unauthorized"
    }
    

HTTP 422 - Unprocessable Entity

    {
      "errors": [
        {
          "error": "UnprocessableEntity",
          "message": "Name can't be blank"
        }
      ]
    }