Skip to main content

POST /trainees/{trainee_id}/placements

Create a placement for this trainee.

Request

POST /api/v1.0-pre/trainees/{trainee_id}/placements

Parameters

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

Request body

Placement details

data

Placement object

Example request body
    {
      "data": {
        "urn": "343452",
        "name": "Oxford School",
        "postcode": "OX1 1AA"
      }
    }
    

Possible responses

HTTP 201 - A placement
    {
      "data": {
        "placement_id": "AXsRAS4LfwZZXvSX7aAfNUb4",
        "school_id": 26214,
        "urn": "123456",
        "name": "Meadow Creek School",
        "postcode": "AB1 2CD",
        "created_at": "2024-01-18T08:02:42.672Z",
        "updated_at": "2024-01-18T08:02:42.672Z"
      }
    }
    
HTTP 401 - Unauthorized
    {
      "error": "Unauthorized"
    }
    
HTTP 404 - Not found
    {
      "errors": [
        {
          "error": "NotFound",
          "message": "Trainee(s) not found"
        }
      ]
    }
    
HTTP 422 - Unprocessable Entity
    {
      "errors": [
        {
          "error": "UnprocessableEntity",
          "message": "Name can't be blank"
        }
      ]
    }