Contents

• API versioning strategy
• Developing on the API
  • OpenAPI
  • Authentication
• Endpoints
  • GET /info
  • GET /trainees
  • GET /trainees/{trainee_id}
  • GET /trainees/{trainee_id}/placements
  • GET /trainees/{trainee_id}/placements/{placement_id}
  • GET /trainees/{trainee_id}/degrees
  • GET /trainees/{trainee_id}/degrees/{degree_id}
  • POST /trainees
  • POST /trainees/{trainee_id}/placements
  • POST /trainees/{trainee_id}/degrees
  • POST /trainees/{trainee_id}/recommend-for-qts
  • POST /trainees/{trainee_id}/defer
  • POST /trainees/{trainee_id}/withdraw
  • PUT|PATCH /trainees/{trainee_id}
  • PUT|PATCH /trainees/{trainee_id}/placements/{placement_id}
  • PUT|PATCH /trainees/{trainee_id}/degrees/{degree_id}
  • DELETE /trainees/{trainee_id}/placements/{placement_id}
  • DELETE /trainees/{trainee_id}/degrees/{degree_id}
• Objects
  • Trainee
  • Placement
  • Degree
• Field lengths summary