Jump to Content
API Reference
Changelog
v1.0-beta
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Changelog
Welcome to TimeEdit's Developer Hub
All
Pages
Start typing to search…
JUMP TO
Start
Welcome to TimeEdit's Developer Hub
Getting Started
What API should I use?
Scheduling REST API
Api Keys
Authenticate Api Key
post
Auth Configs
LIST Auth Configs
get
CREATE Auth Config
post
GET Auth Config
get
PATCH Auth Config
patch
DELETE Auth Config
del
Availability Types
LIST Availability Types
get
CREATE Availability Type
post
GET Availability
get
PATCH Availability Type
patch
DELETE Availability Type
del
LIST limitations for Availability Types
get
Cancellations
FIND Cancellations
post
GET Cancellation
get
Field Relations
LIST Fields Relations
get
CREATE Field Relation
post
GET Field Relation
get
PATCH Field Relation
patch
DELETE Field Relation
del
LIST limitations for Field Relations
get
Fields
FIND Fields
post
CREATE Field
post
GET Field
get
PATCH Field
patch
DELETE Field
del
PATCH sort order for Fields
patch
LIST limitations for Fields
get
Holidays
LIST Holidays
get
LIST Holiday Regions
get
CREATE Holiday Reservation
post
Languages
LIST Languages
get
Limitations
LIST Limitations
get
Member Types
LIST Member Types
get
CREATE Member Type
post
GET Member Type
get
PATCH Member Type
patch
DELETE Member Type
del
LIST limitations for Member Types
get
Objects
FIND Objects
post
BULK Objects
put
CREATE Object
post
UPDATE Object members
post
UPDATE Object relations
post
UPDATE Object optional relations
post
GET Object
get
PATCH Object
patch
DELETE Object
del
LIST limitations for Objects
get
Organization Nodes
FIND Organization Nodes
post
LIST Organization Nodes
get
CREATE Organization Node
post
GET Organization Node
get
PATCH Organization Node
patch
DELETE Organization Node
del
Organizations
GET Organization
get
Padding Rules
LIST Padding Rules
get
CREATE Padding Rule
post
GET Padding Rule
get
PATCH Padding Rule
patch
DELETE Padding Rule
del
LIST limitations for Padding Rules
get
LIST Padding Rules by Object Type
get
Period Headers
LIST Period Headers
get
CREATE Period Header
post
GET Period Header
get
PATCH Period Header
patch
DELETE Period Header
del
Periods
LIST Periods
get
CREATAE Period
post
GET Period
get
PATCH Period
patch
DELETE Period
del
LIST limitations for Periods
get
Permissions
LIST Scopes
get
GET Scope
get
Relation Types
LIST Relation Types
get
CREATE Relation Type
post
GET Relation Type
get
PATCH Relation Type
patch
DELETE Relation Type
del
LIST limitations for Relation Types
get
Reservation Modes
FIND Reservation Modes
post
CREATE Reservation Mode
post
GET Reservation Mode
get
PATCH Reservation Mode
patch
DELETE Reservation Mode
del
LIST limitations for Reservation Modes
get
PATCH sort order for Reservation Modes
patch
Reservation Templates
LIST Reservation Templates
get
CREATE Reservation Template
post
GET Reservation Template
get
PATCH Reservation Template
patch
DELETE Reservation Template
del
Move Reservations to Reservation Template
patch
Validate Reservations and move to trash
patch
LIST limitations for Reservation Templates
get
Reservations
FIND Reservations
post
CREATE Reservation
post
GET Reservation
get
PATCH Reservation
patch
DELETE Reservation
del
Roles
LIST Roles
get
CREATE Role
post
GET Role
get
PATCH Role
patch
DELETE Role
del
LIST limitations for Roles
get
Time Rules
LIST Time Rules
get
CREATE Time Rule
post
GET Time Rule
get
PATCH Time Rule
patch
DELETE Time Rule
del
LIST limitations for Time Rules
get
Types
FIND Types
post
CREATE Type
post
GET Type
get
PATCH Type
patch
DELETE Type
del
LIST External Owners for Types
get
LIST limitations for Types
get
Users
LIST Users
get
CREATE User
post
GET User
get
PATCH User
patch
DELETE User
del
Orders
FIND Orders
post
CREATE Order
post
GET Order
get
PATCH Order
patch
DELETE Order
del
Scheduling SOAP API
About the SOAP API
Getting Started
The data model
SOAP API routes
Authentication
Types
Fields
Objects
Reservations
Cancellations
Orders
Users
Miscellaneous
Exam REST API
Exam
/v3/exams/
get
/v3/exams/
post
/v3/exams/depublish
del
/v3/exams/{examId}
get
/v3/exams/{examId}
del
/v3/exams/{examId}
patch
/v3/exams/{examId}/checklist
patch
/v3/exams/{examId}/reassign
patch
/v3/exams/adjust-planned-students
post
/v3/exams/cancel
post
/v3/exams/uncancel
post
/v3/exams/publish
post
/v3/exams/clone
post
/v3/exams/{examId}/children/
post
/v3/exams/{examId}/registered-students/
get
/v3/exams/{examId}/registered-students/
post
/v3/exams/{examId}/registered-students/
del
/v3/exams/{examId}/registered-students/
patch
/v3/exams/{examId}/registered-students/allocate
post
/v3/exams/{examId}/registered-students/special-needs
post
/v3/exams/{examId}/registered-students/deallocate
post
Room
/v3/rooms/available
get
/v3/rooms/
get
/v3/rooms/sync
post
/v3/rooms/unavailable
get
/v3/rooms/unimport
get
/v3/rooms/import
post
/v3/rooms/{id}
get
/v3/rooms/{id}
del
Exam Type
/v3/exam-types/
get
/v3/exam-types/
post
/v3/exam-types/{examTypeId}
get
/v3/exam-types/{examTypeId}
del
/v3/exam-types/{examTypeId}
patch
Room Booking
/v3/room-bookings/
get
/v3/room-bookings/
post
/v3/room-bookings/
del
/v3/room-bookings/{roomBookingId}/needed-supervisors
patch
/v3/room-bookings/{roomBookingId}
get
/v3/room-bookings/{roomBookingId}
del
/v3/room-bookings/move
patch
/v3/room-bookings/{roomBookingId}/supervisor-bookings
get
/v3/room-bookings/{roomBookingId}/supervisors/available
get
/v3/room-bookings/{roomBookingId}/supervisors
patch
/v3/room-bookings/{roomBookingId}/supervisors/notify
patch
/v3/room-bookings/{roomBookingId}/registered-students/allocated
get
Supervisor Booking
/v3/supervisor-bookings/
get
/v3/supervisor-bookings/
post
/v3/supervisor-bookings/
del
/v3/supervisor-bookings/move
patch
/v3/supervisor-bookings/{status}
patch
/v3/supervisor-bookings/{supervisorBookingId}
get
Supervisor
/v3/supervisors/
get
/v3/supervisors/
post
/v3/supervisors/{supervisorId}
get
/v3/supervisors/{supervisorId}
patch
Exam Slot
/v3/exam-slots/
get
/v3/exam-slots/
post
/v3/exam-slots/{id}
del
/v3/exam-slots/{id}
patch
/v3/exam-slots/{id}/activate
post
Exam Tag
/v3/exam-tags/
get
/v3/exam-tags/
post
/v3/exam-tags/{tagId}
del
/v3/exam-tags/{tagId}
patch
/v3/exam-tags/bulk
post
Exam Scheduling
/v3/exam-schedules/schedule
post
/v3/exam-schedules/{examId}/time
patch
/v3/exam-schedules/move
patch
/v3/exam-schedules/
del
/v3/exam-schedules/one-off
post
Reporting Template
/v3/report-template/
get
/v3/report-template/
post
/v3/report-template/{templateId}
get
/v3/report-template/{templateId}
del
/v3/report-template/{templateId}
patch
Supervisor External Booking
/v3/supervisor-external-bookings/
get
/v3/supervisor-external-bookings/
post
/v3/supervisor-external-bookings/
del
/v3/supervisor-external-bookings/{externalBookingId}/comment
patch
/v3/supervisor-external-bookings/all
get
/v3/supervisor-external-bookings/{externalBookingId}
get
/v3/supervisor-external-bookings/{externalBookingId}
patch
Language
/v3/languages/
get
/v3/languages/
post
/v3/languages/{languageId}
del
/v3/languages/{languageId}
patch
Knowledge Area
/v3/knowledge-areas/
get
/v3/knowledge-areas/
post
/v3/knowledge-areas/{knowledgeAreaId}
get
/v3/knowledge-areas/{knowledgeAreaId}
del
/v3/knowledge-areas/{knowledgeAreaId}
patch
Special Need
/v3/special-needs/
get
/v3/special-needs/
post
/v3/special-needs/{id}
del
/v3/special-needs/{id}
patch
Request Interval
/v3/request-intervals/
get
/v3/request-intervals/
post
/v3/request-intervals/{requestIntervalId}
get
/v3/request-intervals/{requestIntervalId}
del
/v3/request-intervals/{requestIntervalId}
patch
Exam Mandatory Field
/v3/mandatory-objects/
get
/v3/mandatory-objects/
post
/v3/mandatory-objects/
patch
Request Setting
/v3/request-settings/
get
/v3/request-settings/
post
/v3/request-settings/
patch
Public Setting
/v3/public-settings/
get
/v3/public-settings/
post
/v3/public-settings/
patch
Exam Setting
/v3/exam-settings/
get
/v3/exam-settings/
post
/v3/exam-settings/
patch
Supervisor Booking Comment
/v3/supervisor-comments/
get
/v3/supervisor-comments/
post
/v3/supervisor-comments/{commentId}
del
/v3/supervisor-comments/{commentId}
patch
Exam Comment
/v3/exam-comments/
get
/v3/exam-comments/
post
/v3/exam-comments/{commentId}
del
/v3/exam-comments/{commentId}
patch
Student Seating
/v3/student-seatings/
get
/v3/student-seatings/
post
/v3/student-seatings/{id}
del
/v3/student-seatings/{id}
patch
Public
/v3/public/{organizationId}/exams
get
/v3/public/{organizationId}/exams/{examId}
get
/v3/public/{organizationId}/exams/{examId}/registered-students/{studentId}
get
/v3/public/{organizationId}/languages
get
/v3/public/{organizationId}/mandatory-objects
get
/v3/public/{organizationId}/exam-types
get
/v3/public/{organizationId}/settings
get
/v3/public/{organizationId}/request-settings
get
/v3/public/{organizationId}/room-bookings
get
/v3/public/{organizationId}/room-bookings/{roomBookingId}
get
/v3/public/{organizationId}/student-registered-mapping
get
/v3/public/{organizationId}/special-needs
get
Student Mapping
/v3/student-mappings/
get
/v3/student-mappings/
post
/v3/student-mappings/
patch
Supervisor Setting
/v3/supervisor-settings/{organizationId}
get
/v3/supervisor-settings/{organizationId}
patch
Evaluation API
Evaluation
/import/evaluation
get
/import/evaluation
post
/import/evaluation/{id}
get
/import/evaluation/{id}/archive
get
/import/evaluation/{id}/status
post
Feedback
/import/feedback
get
/import/feedback
post
Participant
/import/participant
post
Person
/import/person
get
/import/person
post
/import/person/me
get
/import/person/{id}
del
/import/person/{id}
get
/import/person/{id}/activate
put
Portal
/portal/members
get
/portal/reports/{year}
get
/portal/students
get
/portal/students/mine
get
Curriculum and Workload API
Callback
/canonical/v2/callback/{uid}
post
Assessment
/import/v2/assessment
get
/import/v2/assessment/{id}
get
Calendar
/import/v2/calendar
get
Change
/import/v2/change
get
Csv
/import/v2/csv/raw
post
Faculty
/import/v2/faculty
get
/import/v2/faculty
post
/import/v2/faculty/{id}
get
Field
/import/v2/field
get
Institution
/import/v2/institution
get
Method
/import/v2/method
get
/import/v2/method/{id}
get
Module
/import/v2/module
get
/import/v2/module
post
/import/v2/module/{id}
del
/import/v2/module/{id}
get
Module group
/import/v2/module-group
get
/import/v2/module-group
post
/import/v2/module-group/{id}
del
/import/v2/module-group/{id}
get
Organisation
/import/v2/organisation
get
/import/v2/organisation
post
/import/v2/organisation/{id}
get
Person
/import/v2/person
del
/import/v2/person
get
/import/v2/person
post
/import/v2/person/list
get
/import/v2/person/{id}
del
/import/v2/person/{id}
get
Qualification
/import/v2/qualification
get
/import/v2/qualification
post
/import/v2/qualification/{id}
get
Reference
/import/v2/reference
get
/import/v2/reference
post
/import/v2/reference-type
get
Schedule Preference
/import/v2/schedule-preference
get
Specification
/import/v2/specification
get
/import/v2/specification
post
/import/v2/specification/{id}
get
Status
/import/v2/status
get
Study
/import/v2/study
get
/import/v2/study
post
/import/v2/study/{id}
del
/import/v2/study/{id}
get
Team
/import/v2/team
get
/import/v2/team
post
/import/v2/team/{id}
del
/import/v2/team/{id}
get
Version
/import/v2/version
get
/import/v2/version
post
/import/v2/version/{number}
get
Powered by
Welcome to TimeEdit's Developer Hub
