Overview
Register API Public Interface Full documentation is available here: Register API documentation - Register trainee teachers
Documents
- v2025.0
- Uploaded schema
Who can use this API
HEI ITT providers and SRS vendors
Service level
24/7
Technologies
REST, Ruby on Rails
Environments
| Environment | Base URL |
|---|---|
| dev | |
| live |
You need to sign in to subscribe to an API environment or view your existing subscriptions.
Current release
| Release name | Available from |
|---|---|
| v2025.0 |
Other releases
| Release name | Available from | Available to |
|---|---|---|
| v2026.1 |
Operations
POST create
- Description
-
create
- URL template
- /api/{api_version}/trainees
POST create
- Description
-
create
- URL template
- /api/{api_version}/trainees/{trainee_id}/defer
POST create
- Description
-
create
- URL template
- /api/{api_version}/trainees/{trainee_id}/degrees
POST create
- Description
-
create
- URL template
- /api/{api_version}/trainees/{trainee_id}/placements
POST create
- Description
-
create
- URL template
- /api/{api_version}/trainees/{trainee_id}/recommend-for-qts
POST create
- Description
-
create
- URL template
- /api/{api_version}/trainees/{trainee_id}/withdraw
DELETE destroy
- Description
-
destroy
- URL template
- /api/{api_version}/trainees/{trainee_id}/degrees/{degree_id}
DELETE destroy
- Description
-
destroy
- URL template
- /api/{api_version}/trainees/{trainee_id}/placements/{placement_id}
GET index
- Description
-
index
- URL template
- /api/{api_version}/trainees
GET index
- Description
-
index
- URL template
- /api/{api_version}/trainees/{trainee_id}/degrees
GET index
- Description
-
index
- URL template
- /api/{api_version}/trainees/{trainee_id}/placements
GET show
- Description
-
show
- URL template
- /api/{api_version}/info
GET show
- Description
-
show
- URL template
- /api/{api_version}/trainees/{trainee_id}
GET show
- Description
-
show
- URL template
- /api/{api_version}/trainees/{trainee_id}/degrees/{degree_id}
GET show
- Description
-
show
- URL template
- /api/{api_version}/trainees/{trainee_id}/placements/{placement_id}
PUT update
- Description
-
update
- URL template
- /api/{api_version}/trainees/{trainee_id}
PUT update
- Description
-
update
- URL template
- /api/{api_version}/trainees/{trainee_id}/degrees/{degree_id}
PUT update
- Description
-
update
- URL template
- /api/{api_version}/trainees/{trainee_id}/placements/{placement_id}
Back to top