The API can only be accessed by creating a token at: https://ans.app/users/tokens.
The provided token is a Bearer token and needs to be set in the Request Header with key Authorization and value "Bearer [token]" for every request.
The API generates several headers due to its use of pagination, this includes:
- Link, the standard link header defined in RFC 8288
- Current-Page, which shows the current page of the requested data
- Page-Items, which shows the amount of items per page
- Total-Pages, which shows the total amount of pages available
- Total-Count, which shows the total count of objects that was requested
The API enforces a rate limit of 500 request per minute per ip-address. If the rate limit is exceeded, the API responds with a HTTP 429 Too Many Requests response code.
You can use the following response headers to confirm the current rate limit and monitor the number of requests remaining in the current minute.
- RateLimit-Limit, the current limit for your account
- RateLimit-Remaining, the number of remaining requests in the current minute
- RateLimit-Reset, the number of seconds until the limit is reset
The API offers search functionality through GET requests with a query. For all search endpoints see the Search section.
- The query must consist of the attribute and the search value connected with a colon (:) or a greater than (>) or smaller than (<) sign.
- You can use the greater and smaller than symbols for numeric and date values.
- If your search value contains whitespaces, you must quote your search query with single or double quotes.
- You can also combine searches by using a whitespace to separate the attributes.
- If your search value is equal to "null", all records with null values for that attribute will be found.
- We perform case sensitive exact match searches only.
- You can search for multiple values, by adding square brackets around the search parameters and seperating the parameters using commas without spaces.
- You can see some example queries in the documented search endpoints.
The API offers you the ability to listen to specific events that occur within the application. For example, you can use webhooks to:
- Archive results when an assignment is archived
- Add users after an assignment is created
- Export a result after it has been approved When creating a webhook you can specify which events you want to listen to. You can listen to all events, all events for a specific object or only one event for an object.
You can listen to 'create', 'update' and 'destroy' events on an object or a combination for example:
- '*' - all events for all objects
- 'assignment' - All events for an assignment
- 'assignment.update' - Only notify when an assignment is updated
The webhooks API returns a secret after creating a new webhook. This secret can be used to verify that the webhook call comes from Ans by creating a sha256 HMAC with the request body and this secret and comparing it to the X-Ans-Signature Header.
Webhook requests are automatically retried up to five times if the endpoint returns certain HTTP response codes. The time interval between retries is gradually extended. Every webhook event is logged and contains the response code, headers and body of the response for debugging purposes.
The following objects are currently supported:
- Assignment
- Result
- User
This Python package is automatically generated by the Swagger Codegen project:
- API version: v2
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/rjadr/ans-app-api.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/rjadr/ans-app-api.git
)
Then import the package:
import ans_app_api
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import ans_app_api
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import ans_app_api
from ans_app_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = ans_app_api.AssignmentLabelsApi(ans_app_api.ApiClient(configuration))
id = 'id_example' # str | id
try:
# Delete assignment label
api_instance.api_v2_labels_id_delete(id)
except ApiException as e:
print("Exception when calling AssignmentLabelsApi->api_v2_labels_id_delete: %s\n" % e)
# create an instance of the API class
api_instance = ans_app_api.AssignmentLabelsApi(ans_app_api.ApiClient(configuration))
id = 'id_example' # str | id
try:
# Show assignment label
api_instance.api_v2_labels_id_get(id)
except ApiException as e:
print("Exception when calling AssignmentLabelsApi->api_v2_labels_id_get: %s\n" % e)
# create an instance of the API class
api_instance = ans_app_api.AssignmentLabelsApi(ans_app_api.ApiClient(configuration))
id = 'id_example' # str | id
body = ans_app_api.LabelsIdBody() # LabelsIdBody | (optional)
try:
# Update assignment label
api_instance.api_v2_labels_id_patch(id, body=body)
except ApiException as e:
print("Exception when calling AssignmentLabelsApi->api_v2_labels_id_patch: %s\n" % e)
# create an instance of the API class
api_instance = ans_app_api.AssignmentLabelsApi(ans_app_api.ApiClient(configuration))
school_id = 'school_id_example' # str | school_id
items = 56 # int | Items per page, possible values are 5, 10, 20, 50 and 100 (optional)
page = 56 # int | Page number (optional)
try:
# List assignment labels
api_instance.api_v2_schools_school_id_labels_get(school_id, items=items, page=page)
except ApiException as e:
print("Exception when calling AssignmentLabelsApi->api_v2_schools_school_id_labels_get: %s\n" % e)
# create an instance of the API class
api_instance = ans_app_api.AssignmentLabelsApi(ans_app_api.ApiClient(configuration))
school_id = 'school_id_example' # str | school_id
body = ans_app_api.SchoolIdLabelsBody() # SchoolIdLabelsBody | (optional)
try:
# Create assignment label
api_instance.api_v2_schools_school_id_labels_post(school_id, body=body)
except ApiException as e:
print("Exception when calling AssignmentLabelsApi->api_v2_schools_school_id_labels_post: %s\n" % e)
All URIs are relative to https://ans.app
Class | Method | HTTP request | Description |
---|---|---|---|
AssignmentLabelsApi | api_v2_labels_id_delete | DELETE /api/v2/labels/{id} | Delete assignment label |
AssignmentLabelsApi | api_v2_labels_id_get | GET /api/v2/labels/{id} | Show assignment label |
AssignmentLabelsApi | api_v2_labels_id_patch | PATCH /api/v2/labels/{id} | Update assignment label |
AssignmentLabelsApi | api_v2_schools_school_id_labels_get | GET /api/v2/schools/{school_id}/labels | List assignment labels |
AssignmentLabelsApi | api_v2_schools_school_id_labels_post | POST /api/v2/schools/{school_id}/labels | Create assignment label |
AssignmentsApi | api_v2_assignments_id_delete | DELETE /api/v2/assignments/{id} | Delete assignment |
AssignmentsApi | api_v2_assignments_id_get | GET /api/v2/assignments/{id} | Show assignment |
AssignmentsApi | api_v2_assignments_id_patch | PATCH /api/v2/assignments/{id} | Update assignment |
AssignmentsApi | api_v2_courses_course_id_assignments_get | GET /api/v2/courses/{course_id}/assignments | List assignments |
AssignmentsApi | api_v2_courses_course_id_assignments_post | POST /api/v2/courses/{course_id}/assignments | Create assignment |
BackgroundJobsApi | api_v2_background_jobs_get | GET /api/v2/background_jobs | List background jobs |
BackgroundJobsApi | api_v2_background_jobs_id_get | GET /api/v2/background_jobs/{id} | Show background job |
BackgroundJobsApi | api_v2_background_jobs_id_patch | PATCH /api/v2/background_jobs/{id} | Update background job |
BlueprintsApi | api_v2_blueprints_id_get | GET /api/v2/blueprints/{id} | Show blueprint |
BlueprintsApi | api_v2_question_banks_question_bank_id_blueprints_get | GET /api/v2/question_banks/{question_bank_id}/blueprints | List blueprints |
ClassesApi | api_v2_classes_id_delete | DELETE /api/v2/classes/{id} | Delete class |
ClassesApi | api_v2_classes_id_get | GET /api/v2/classes/{id} | Show class |
ClassesApi | api_v2_classes_id_patch | PATCH /api/v2/classes/{id} | Update class |
ClassesApi | api_v2_schools_school_id_classes_get | GET /api/v2/schools/{school_id}/classes | List Classes |
ClassesApi | api_v2_schools_school_id_classes_post | POST /api/v2/schools/{school_id}/classes | Create classes |
CommentsApi | api_v2_comments_get | GET /api/v2/comments | List comments |
CommentsApi | api_v2_comments_id_delete | DELETE /api/v2/comments/{id} | Destroy comment |
CommentsApi | api_v2_comments_id_get | GET /api/v2/comments/{id} | Show comment |
CommentsApi | api_v2_comments_id_patch | PATCH /api/v2/comments/{id} | Update comment |
CommentsApi | api_v2_comments_post | POST /api/v2/comments | Create comment |
CoursesApi | api_v2_courses_id_delete | DELETE /api/v2/courses/{id} | Delete course |
CoursesApi | api_v2_courses_id_get | GET /api/v2/courses/{id} | Show course |
CoursesApi | api_v2_courses_id_patch | PATCH /api/v2/courses/{id} | Update course |
CoursesApi | api_v2_schools_school_id_courses_get | GET /api/v2/schools/{school_id}/courses | List courses |
CoursesApi | api_v2_schools_school_id_courses_post | POST /api/v2/schools/{school_id}/courses | Create course |
CoursesClassesApi | api_v2_classes_class_id_courses_classes_get | GET /api/v2/classes/{class_id}/courses_classes | List courses in class |
CoursesClassesApi | api_v2_classes_class_id_courses_classes_post | POST /api/v2/classes/{class_id}/courses_classes | Add course to class |
CoursesClassesApi | api_v2_courses_classes_id_delete | DELETE /api/v2/courses_classes/{id} | Delete courses class |
CoursesClassesApi | api_v2_courses_course_id_courses_classes_get | GET /api/v2/courses/{course_id}/courses_classes | List classes in course |
CoursesClassesApi | api_v2_courses_course_id_courses_classes_post | POST /api/v2/courses/{course_id}/courses_classes | Add class to course |
CoursesUsersApi | api_v2_courses_course_id_courses_users_get | GET /api/v2/courses/{course_id}/courses_users | List course users |
CoursesUsersApi | api_v2_courses_course_id_courses_users_post | POST /api/v2/courses/{course_id}/courses_users | Add user to course |
CoursesUsersApi | api_v2_courses_users_id_delete | DELETE /api/v2/courses_users/{id} | Delete courses user |
CoursesUsersApi | api_v2_courses_users_id_get | GET /api/v2/courses_users/{id} | Show courses user |
CoursesUsersApi | api_v2_courses_users_id_patch | PATCH /api/v2/courses_users/{id} | Update courses user |
CoursesUsersApi | api_v2_users_user_id_courses_users_get | GET /api/v2/users/{user_id}/courses_users | List user courses |
CoursesUsersApi | api_v2_users_user_id_courses_users_post | POST /api/v2/users/{user_id}/courses_users | Add user to course |
CoversApi | api_v2_assignments_assignment_id_cover_get | GET /api/v2/assignments/{assignment_id}/cover | Show cover |
CoversApi | api_v2_assignments_assignment_id_cover_patch | PATCH /api/v2/assignments/{assignment_id}/cover | Update cover |
CoversApi | api_v2_question_bank_assignments_question_bank_assignment_id_cover_get | GET /api/v2/question_bank_assignments/{question_bank_assignment_id}/cover | Show cover |
CoversApi | api_v2_question_bank_assignments_question_bank_assignment_id_cover_patch | PATCH /api/v2/question_bank_assignments/{question_bank_assignment_id}/cover | Update cover |
DepartmentsApi | api_v2_departments_id_delete | DELETE /api/v2/departments/{id} | Delete department |
DepartmentsApi | api_v2_departments_id_get | GET /api/v2/departments/{id} | Show department |
DepartmentsApi | api_v2_departments_id_patch | PATCH /api/v2/departments/{id} | Update department |
DepartmentsApi | api_v2_schools_school_id_departments_get | GET /api/v2/schools/{school_id}/departments | List departments |
DepartmentsApi | api_v2_schools_school_id_departments_post | POST /api/v2/schools/{school_id}/departments | Create department |
DomainsApi | api_v2_courses_course_id_domains_get | GET /api/v2/courses/{course_id}/domains | List course domains |
DomainsApi | api_v2_courses_course_id_domains_post | POST /api/v2/courses/{course_id}/domains | Create course domain |
DomainsApi | api_v2_domains_id_delete | DELETE /api/v2/domains/{id} | Delete domain |
DomainsApi | api_v2_domains_id_get | GET /api/v2/domains/{id} | Show domain |
DomainsApi | api_v2_domains_id_patch | PATCH /api/v2/domains/{id} | Update domain |
DomainsApi | api_v2_question_banks_question_bank_id_domains_get | GET /api/v2/question_banks/{question_bank_id}/domains | List question bank domains |
DomainsApi | api_v2_question_banks_question_bank_id_domains_post | POST /api/v2/question_banks/{question_bank_id}/domains | Create question bank domain |
ExercisesApi | api_v2_assignments_assignment_id_exercises_get | GET /api/v2/assignments/{assignment_id}/exercises | List exercises |
ExercisesApi | api_v2_assignments_assignment_id_exercises_post | POST /api/v2/assignments/{assignment_id}/exercises | Create exercise |
ExercisesApi | api_v2_exercises_id_delete | DELETE /api/v2/exercises/{id} | Delete exercise |
ExercisesApi | api_v2_exercises_id_get | GET /api/v2/exercises/{id} | Show exercise |
ExercisesApi | api_v2_exercises_id_patch | PATCH /api/v2/exercises/{id} | Update exercise |
FormsApi | api_v2_assignments_assignment_id_forms_delete | DELETE /api/v2/assignments/{assignment_id}/forms | Delete forms |
FormsApi | api_v2_assignments_assignment_id_forms_get | GET /api/v2/assignments/{assignment_id}/forms | List forms |
GroupsApi | api_v2_courses_course_id_groups_get | GET /api/v2/courses/{course_id}/groups | List groups |
GroupsApi | api_v2_courses_course_id_groups_post | POST /api/v2/courses/{course_id}/groups | Create group |
GroupsApi | api_v2_groups_id_delete | DELETE /api/v2/groups/{id} | Delete group |
GroupsApi | api_v2_groups_id_get | GET /api/v2/groups/{id} | Show group |
GroupsApi | api_v2_groups_id_patch | PATCH /api/v2/groups/{id} | Update group |
GroupsUsersApi | api_v2_groups_group_id_groups_users_get | GET /api/v2/groups/{group_id}/groups_users | List users in group |
GroupsUsersApi | api_v2_groups_group_id_groups_users_post | POST /api/v2/groups/{group_id}/groups_users | Add user to group |
GroupsUsersApi | api_v2_groups_users_id_delete | DELETE /api/v2/groups_users/{id} | Remove user from group |
GroupsUsersApi | api_v2_users_user_id_groups_users_get | GET /api/v2/users/{user_id}/groups_users | List groups of user |
GroupsUsersApi | api_v2_users_user_id_groups_users_post | POST /api/v2/users/{user_id}/groups_users | Add user to group |
InsightsApi | api_v2_insights_assignments_id_get | GET /api/v2/insights/assignments/{id} | Show insights |
InsightsApi | api_v2_insights_questions_id_get | GET /api/v2/insights/questions/{id} | Show insights |
LocationsApi | api_v2_locations_id_delete | DELETE /api/v2/locations/{id} | Delete location |
LocationsApi | api_v2_locations_id_get | GET /api/v2/locations/{id} | Show Location |
LocationsApi | api_v2_locations_id_patch | PATCH /api/v2/locations/{id} | Update location |
LocationsApi | api_v2_schools_school_id_locations_get | GET /api/v2/schools/{school_id}/locations | List locations |
LocationsApi | api_v2_schools_school_id_locations_post | POST /api/v2/schools/{school_id}/locations | Create location |
LogsApi | api_v2_logs_assignments_id_get | GET /api/v2/logs/assignments/{id} | Show assignment log |
LogsApi | api_v2_logs_courses_id_get | GET /api/v2/logs/courses/{id} | Show course log |
LogsApi | api_v2_logs_courses_users_id_get | GET /api/v2/logs/courses_users/{id} | Show courses users log |
LogsApi | api_v2_logs_responses_id_get | GET /api/v2/logs/responses/{id} | Show response log |
LogsApi | api_v2_logs_results_id_get | GET /api/v2/logs/results/{id} | Show result log |
LogsApi | api_v2_logs_schools_id_get | GET /api/v2/logs/schools/{id} | Show school log |
LogsApi | api_v2_logs_submissions_id_get | GET /api/v2/logs/submissions/{id} | Show submission log |
LogsApi | api_v2_logs_subsets_id_get | GET /api/v2/logs/subsets/{id} | Show subset log |
LogsApi | api_v2_logs_users_id_get | GET /api/v2/logs/users/{id} | Show user log |
NotificationsApi | api_v2_notifications_get | GET /api/v2/notifications | List notifications |
NotificationsApi | api_v2_notifications_id_get | GET /api/v2/notifications/{id} | Show notification |
ObjectivesApi | api_v2_domains_domain_id_objectives_get | GET /api/v2/domains/{domain_id}/objectives | List objectives |
ObjectivesApi | api_v2_domains_domain_id_objectives_post | POST /api/v2/domains/{domain_id}/objectives | Create objective |
ObjectivesApi | api_v2_objectives_id_delete | DELETE /api/v2/objectives/{id} | Delete objective |
ObjectivesApi | api_v2_objectives_id_get | GET /api/v2/objectives/{id} | Show objective |
ObjectivesApi | api_v2_objectives_id_patch | PATCH /api/v2/objectives/{id} | Update objective |
PeriodsApi | api_v2_periods_id_delete | DELETE /api/v2/periods/{id} | Delete period |
PeriodsApi | api_v2_periods_id_get | GET /api/v2/periods/{id} | Show period |
PeriodsApi | api_v2_periods_id_patch | PATCH /api/v2/periods/{id} | Update period |
PeriodsApi | api_v2_schools_school_id_periods_get | GET /api/v2/schools/{school_id}/periods | List periods |
PeriodsApi | api_v2_schools_school_id_periods_post | POST /api/v2/schools/{school_id}/periods | Create period |
PlansApi | api_v2_plans_id_delete | DELETE /api/v2/plans/{id} | Delete plan |
PlansApi | api_v2_plans_id_get | GET /api/v2/plans/{id} | Show plan |
PlansApi | api_v2_plans_id_patch | PATCH /api/v2/plans/{id} | Update plan |
PlansApi | api_v2_publishers_publisher_id_plans_get | GET /api/v2/publishers/{publisher_id}/plans | List plans |
PlansApi | api_v2_publishers_publisher_id_plans_post | POST /api/v2/publishers/{publisher_id}/plans | Create plan |
PublicationTimeslotsApi | api_v2_assignments_assignment_id_publication_timeslots_get | GET /api/v2/assignments/{assignment_id}/publication_timeslots | List publication timeslots |
PublicationTimeslotsApi | api_v2_assignments_assignment_id_publication_timeslots_post | POST /api/v2/assignments/{assignment_id}/publication_timeslots | Create publication timeslot |
PublicationTimeslotsApi | api_v2_publication_timeslots_id_delete | DELETE /api/v2/publication_timeslots/{id} | Delete publication timeslot |
PublicationTimeslotsApi | api_v2_publication_timeslots_id_get | GET /api/v2/publication_timeslots/{id} | Show publication timeslot |
PublicationTimeslotsApi | api_v2_publication_timeslots_id_patch | PATCH /api/v2/publication_timeslots/{id} | Update publication timeslot |
PublicationsApi | api_v2_assignments_assignment_id_publication_get | GET /api/v2/assignments/{assignment_id}/publication | Show publication |
PublicationsApi | api_v2_assignments_assignment_id_publication_patch | PATCH /api/v2/assignments/{assignment_id}/publication | Update publication |
QtiApi | api_v2_qti_results_id_get | GET /api/v2/qti/results/{id} | QTI export |
QuestionBankAssignmentsApi | api_v2_question_bank_assignments_id_delete | DELETE /api/v2/question_bank_assignments/{id} | Delete question bank assignment |
QuestionBankAssignmentsApi | api_v2_question_bank_assignments_id_get | GET /api/v2/question_bank_assignments/{id} | Show question bank assignment |
QuestionBankAssignmentsApi | api_v2_question_bank_assignments_id_patch | PATCH /api/v2/question_bank_assignments/{id} | Update question bank assignment |
QuestionBankAssignmentsApi | api_v2_question_bank_assignments_question_bank_assignment_id_question_bank_assignment_results_get | GET /api/v2/question_bank_assignments/{question_bank_assignment_id}/question_bank_assignment_results | List question bank assignment results |
QuestionBankAssignmentsApi | api_v2_question_banks_question_bank_id_question_bank_assignments_get | GET /api/v2/question_banks/{question_bank_id}/question_bank_assignments | List question bank assignments |
QuestionBankAssignmentsApi | api_v2_question_banks_question_bank_id_question_bank_assignments_post | POST /api/v2/question_banks/{question_bank_id}/question_bank_assignments | Create question bank assignment |
QuestionBankExercisesApi | api_v2_question_bank_exercises_id_delete | DELETE /api/v2/question_bank_exercises/{id} | Delete question bank exercise |
QuestionBankExercisesApi | api_v2_question_bank_exercises_id_get | GET /api/v2/question_bank_exercises/{id} | Show question bank exercise |
QuestionBankExercisesApi | api_v2_question_bank_exercises_id_patch | PATCH /api/v2/question_bank_exercises/{id} | Update question bank exercise |
QuestionBankExercisesApi | api_v2_question_banks_question_bank_id_question_bank_exercises_get | GET /api/v2/question_banks/{question_bank_id}/question_bank_exercises | List question bank exercises |
QuestionBankExercisesApi | api_v2_question_banks_question_bank_id_question_bank_exercises_import_get | GET /api/v2/question_banks/{question_bank_id}/question_bank_exercises/import | Import question bank exercises |
QuestionBankExercisesApi | api_v2_question_banks_question_bank_id_question_bank_exercises_post | POST /api/v2/question_banks/{question_bank_id}/question_bank_exercises | Create question bank exercise |
QuestionBankLabelsApi | api_v2_question_bank_labels_id_delete | DELETE /api/v2/question_bank_labels/{id} | Delete question bank label |
QuestionBankLabelsApi | api_v2_question_bank_labels_id_get | GET /api/v2/question_bank_labels/{id} | Show question bank label |
QuestionBankLabelsApi | api_v2_question_bank_labels_id_patch | PATCH /api/v2/question_bank_labels/{id} | Update question bank label |
QuestionBankLabelsApi | api_v2_question_banks_question_bank_id_question_bank_labels_get | GET /api/v2/question_banks/{question_bank_id}/question_bank_labels | List question bank labels |
QuestionBankLabelsApi | api_v2_question_banks_question_bank_id_question_bank_labels_post | POST /api/v2/question_banks/{question_bank_id}/question_bank_labels | Create question bank label |
QuestionBanksApi | api_v2_question_banks_get | GET /api/v2/question_banks | List question banks |
QuestionBanksApi | api_v2_question_banks_id_delete | DELETE /api/v2/question_banks/{id} | Delete question bank |
QuestionBanksApi | api_v2_question_banks_id_get | GET /api/v2/question_banks/{id} | Show question bank |
QuestionBanksApi | api_v2_question_banks_id_patch | PATCH /api/v2/question_banks/{id} | Update question bank |
QuestionBanksApi | api_v2_question_banks_post | POST /api/v2/question_banks | Create question bank |
QuestionsApi | api_v2_exercises_exercise_id_questions_get | GET /api/v2/exercises/{exercise_id}/questions | List questions |
QuestionsApi | api_v2_exercises_exercise_id_questions_post | POST /api/v2/exercises/{exercise_id}/questions | Create question |
QuestionsApi | api_v2_questions_id_delete | DELETE /api/v2/questions/{id} | Delete question |
QuestionsApi | api_v2_questions_id_get | GET /api/v2/questions/{id} | Show question |
QuestionsApi | api_v2_questions_id_patch | PATCH /api/v2/questions/{id} | Update question |
RequirementsApi | api_v2_assignments_assignment_id_requirements_get | GET /api/v2/assignments/{assignment_id}/requirements | List requirements |
RequirementsApi | api_v2_assignments_assignment_id_requirements_post | POST /api/v2/assignments/{assignment_id}/requirements | Create requirement |
RequirementsApi | api_v2_requirements_id_delete | DELETE /api/v2/requirements/{id}/ | Delete requirement |
RequirementsApi | api_v2_requirements_id_get | GET /api/v2/requirements/{id}/ | Show requirement |
RequirementsApi | api_v2_requirements_id_patch | PATCH /api/v2/requirements/{id}/ | Update requirement |
ResultFilesApi | api_v2_files_id_delete | DELETE /api/v2/files/{id} | Delete file |
ResultFilesApi | api_v2_results_result_id_files_new_get | GET /api/v2/results/{result_id}/files/new | Request url to upload a file |
ResultFilesApi | api_v2_results_result_id_files_post | POST /api/v2/results/{result_id}/files | Create file |
ResultsApi | api_v2_assignments_assignment_id_results_get | GET /api/v2/assignments/{assignment_id}/results | List results |
ResultsApi | api_v2_assignments_assignment_id_results_post | POST /api/v2/assignments/{assignment_id}/results | Create result |
ResultsApi | api_v2_results_id_delete | DELETE /api/v2/results/{id} | Delete result |
ResultsApi | api_v2_results_id_get | GET /api/v2/results/{id} | Show result |
ResultsApi | api_v2_results_id_patch | PATCH /api/v2/results/{id} | Update result |
ReviewsApi | api_v2_reviews_id_get | GET /api/v2/reviews/{id} | Show review |
RolesApi | api_v2_schools_school_id_roles_get | GET /api/v2/schools/{school_id}/roles | List roles |
SchoolsApi | api_v2_schools_id_get | GET /api/v2/schools/{id} | Show school |
SchoolsApi | api_v2_schools_id_patch | PATCH /api/v2/schools/{id} | Update school |
ScoreMarksApi | api_v2_assignments_assignment_id_score_marks_get | GET /api/v2/assignments/{assignment_id}/score_marks | List score marks |
ScoreMarksApi | api_v2_assignments_assignment_id_score_marks_post | POST /api/v2/assignments/{assignment_id}/score_marks | Create score mark |
ScoreMarksApi | api_v2_question_bank_assignments_question_bank_assignment_id_score_marks_get | GET /api/v2/question_bank_assignments/{question_bank_assignment_id}/score_marks | List question bank assignment score marks |
ScoreMarksApi | api_v2_question_bank_assignments_question_bank_assignment_id_score_marks_post | POST /api/v2/question_bank_assignments/{question_bank_assignment_id}/score_marks | Create question bank assignment score mark |
ScoreMarksApi | api_v2_score_marks_id_delete | DELETE /api/v2/score_marks/{id} | Delete score mark |
ScoreMarksApi | api_v2_score_marks_id_get | GET /api/v2/score_marks/{id} | Show score mark |
ScoreMarksApi | api_v2_score_marks_id_patch | PATCH /api/v2/score_marks/{id} | Update score mark |
SearchApi | api_v2_search_assignments_get | GET /api/v2/search/assignments | Search assignments |
SearchApi | api_v2_search_courses_get | GET /api/v2/search/courses | Search courses |
SearchApi | api_v2_search_groups_get | GET /api/v2/search/groups | Search groups |
SearchApi | api_v2_search_question_bank_assignments_get | GET /api/v2/search/question_bank_assignments | Search question bank assignments |
SearchApi | api_v2_search_question_banks_get | GET /api/v2/search/question_banks | Search question banks |
SearchApi | api_v2_search_results_get | GET /api/v2/search/results | Search results |
SearchApi | api_v2_search_timeslots_get | GET /api/v2/search/timeslots | Search timeslots |
SearchApi | api_v2_search_users_get | GET /api/v2/search/users | Search users |
StudiesApi | api_v2_departments_department_id_studies_get | GET /api/v2/departments/{department_id}/studies | List studies |
StudiesApi | api_v2_departments_department_id_studies_post | POST /api/v2/departments/{department_id}/studies | Create study |
StudiesApi | api_v2_studies_id_delete | DELETE /api/v2/studies/{id} | Delete study |
StudiesApi | api_v2_studies_id_get | GET /api/v2/studies/{id} | Show study |
StudiesApi | api_v2_studies_id_patch | PATCH /api/v2/studies/{id} | Update study |
SubmissionsApi | api_v2_submissions_id_get | GET /api/v2/submissions/{id} | Show submission |
SubmissionsApi | api_v2_submissions_id_patch | PATCH /api/v2/submissions/{id} | Update submission |
SubscriptionsApi | api_v2_plans_plan_id_subscriptions_get | GET /api/v2/plans/{plan_id}/subscriptions | List subscriptions |
SubscriptionsApi | api_v2_plans_plan_id_subscriptions_post | POST /api/v2/plans/{plan_id}/subscriptions | Create subscription |
SubscriptionsApi | api_v2_subscriptions_id_delete | DELETE /api/v2/subscriptions/{id} | Delete subscription |
SubscriptionsApi | api_v2_subscriptions_id_get | GET /api/v2/subscriptions/{id} | Show subscription |
SubscriptionsApi | api_v2_subscriptions_id_patch | PATCH /api/v2/subscriptions/{id} | Update subscription |
TasksApi | api_v2_assignments_assignment_id_tasks_get | GET /api/v2/assignments/{assignment_id}/tasks | List assignment tasks |
TasksApi | api_v2_assignments_assignment_id_tasks_post | POST /api/v2/assignments/{assignment_id}/tasks | Create assignment task |
TasksApi | api_v2_question_banks_question_bank_id_tasks_get | GET /api/v2/question_banks/{question_bank_id}/tasks | List question bank tasks |
TasksApi | api_v2_question_banks_question_bank_id_tasks_post | POST /api/v2/question_banks/{question_bank_id}/tasks | Create question bank task |
TasksApi | api_v2_tasks_id_delete | DELETE /api/v2/tasks/{id} | Delete task |
TasksApi | api_v2_tasks_id_get | GET /api/v2/tasks/{id} | Show task |
TasksApi | api_v2_tasks_id_patch | PATCH /api/v2/tasks/{id} | Update task |
TimeslotsApi | api_v2_assignments_assignment_id_timeslots_get | GET /api/v2/assignments/{assignment_id}/timeslots | List timeslots |
TimeslotsApi | api_v2_assignments_assignment_id_timeslots_post | POST /api/v2/assignments/{assignment_id}/timeslots | Create timeslot |
TimeslotsApi | api_v2_timeslots_id_delete | DELETE /api/v2/timeslots/{id} | Delete timeslot |
TimeslotsApi | api_v2_timeslots_id_get | GET /api/v2/timeslots/{id} | Show timeslot |
TimeslotsApi | api_v2_timeslots_id_patch | PATCH /api/v2/timeslots/{id} | Update timeslot |
UsersApi | api_v2_schools_school_id_users_get | GET /api/v2/schools/{school_id}/users | List users |
UsersApi | api_v2_schools_school_id_users_post | POST /api/v2/schools/{school_id}/users | Create user |
UsersApi | api_v2_users_id_delete | DELETE /api/v2/users/{id} | Delete user |
UsersApi | api_v2_users_id_get | GET /api/v2/users/{id} | Show user |
UsersApi | api_v2_users_id_patch | PATCH /api/v2/users/{id} | Update user |
WebhooksApi | api_v2_webhooks_get | GET /api/v2/webhooks/ | List webhooks |
WebhooksApi | api_v2_webhooks_id_delete | DELETE /api/v2/webhooks/{id} | Delete webhook |
WebhooksApi | api_v2_webhooks_id_get | GET /api/v2/webhooks/{id} | Show webhook |
WebhooksApi | api_v2_webhooks_id_patch | PATCH /api/v2/webhooks/{id} | Update webhook |
WebhooksApi | api_v2_webhooks_post | POST /api/v2/webhooks/ | Create webhook |
- Apiv2coursescourseIdassignmentsAccessibilitySettings
- Apiv2coursescourseIdassignmentsAccessibilitySettings1
- Apiv2coursescourseIdassignmentsExerciseReviewers
- Apiv2coursescourseIdassignmentsGradesSettings
- Apiv2coursescourseIdassignmentsGradesSettings1
- Apiv2coursescourseIdassignmentsGroupReviewers
- Apiv2coursescourseIdassignmentsIntegrations
- Apiv2coursescourseIdassignmentsIntegrations1
- Apiv2coursescourseIdassignmentsIntegrations1ExamServices
- Apiv2coursescourseIdassignmentsIntegrations1Ouriginal
- Apiv2coursescourseIdassignmentsIntegrations1ProctorExam
- Apiv2coursescourseIdassignmentsIntegrations1Proctorio
- Apiv2coursescourseIdassignmentsIntegrations1SafeExamBrowser
- Apiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfig
- Apiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigPermittedProcesses
- Apiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigProhibitedProcesses
- Apiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigURLFilterRules
- Apiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserServer
- Apiv2coursescourseIdassignmentsIntegrations1Step
- Apiv2coursescourseIdassignmentsIntegrationsSafeExamBrowser
- Apiv2coursescourseIdassignmentsIntegrationsSafeExamBrowserConfig
- Apiv2coursescourseIdassignmentsIntegrationsSafeExamBrowserConfigPermittedProcesses
- Apiv2coursescourseIdassignmentsIntegrationsSafeExamBrowserConfigProhibitedProcesses
- Apiv2coursescourseIdassignmentsIntegrationsSafeExamBrowserConfigURLFilterRules
- Apiv2coursescourseIdassignmentsIntegrationsSafeExamBrowserServer
- Apiv2questionBanksquestionBankIdquestionBankAssignmentsGradesSettings
- Apiv2questionBanksquestionBankIdquestionBankAssignmentsGradesSettings1
- Apiv2questionBanksquestionBankIdquestionBankExercisesTags
- Apiv2schoolsschoolIdcoursesInvigilators
- Apiv2schoolsschoolIdcoursesLearners
- Apiv2schoolsschoolIdusersCourses
- Apiv2schoolsschoolIdusersQuestionBanks
- Apiv2webhooksEvents
- AssignmentIdCoverBody
- AssignmentIdExercisesBody
- AssignmentIdPublicationBody
- AssignmentIdPublicationTimeslotsBody
- AssignmentIdRequirementsBody
- AssignmentIdResultsBody
- AssignmentIdScoreMarksBody
- AssignmentIdTasksBody
- AssignmentIdTimeslotsBody
- AssignmentsIdBody
- BackgroundJobsIdBody
- ClassIdCoursesClassesBody
- ClassesIdBody
- CommentsIdBody
- CourseIdAssignmentsBody
- CourseIdCoursesClassesBody
- CourseIdCoursesUsersBody
- CourseIdDomainsBody
- CourseIdGroupsBody
- CoursesIdBody
- CoursesUsersIdBody
- DepartmentIdStudiesBody
- DepartmentsIdBody
- DomainIdObjectivesBody
- DomainsIdBody
- ExerciseIdQuestionsBody
- ExercisesIdBody
- GroupIdGroupsUsersBody
- GroupsIdBody
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20011
- InlineResponse20012
- InlineResponse20013
- InlineResponse20014
- InlineResponse20015
- InlineResponse20016
- InlineResponse20017
- InlineResponse20018
- InlineResponse20019
- InlineResponse20019Assignments
- InlineResponse2002
- InlineResponse20020
- InlineResponse20021
- InlineResponse20022
- InlineResponse20023
- InlineResponse20023Exercise
- InlineResponse20023ProctorExam
- InlineResponse20023ProctorExamStudentSession
- InlineResponse20023Result
- InlineResponse20023User
- InlineResponse20024
- InlineResponse20025
- InlineResponse20025Scores
- InlineResponse20026
- InlineResponse20027
- InlineResponse20028
- InlineResponse20029
- InlineResponse20029Courses
- InlineResponse20029Departments
- InlineResponse20029QuestionBanks
- InlineResponse2003
- InlineResponse20030
- InlineResponse2004
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- InlineResponse201
- InlineResponse2011
- InlineResponse2011Courses
- InlineResponse2011Users
- InlineResponse2012
- InlineResponse2012Classes
- InlineResponse2012Periods
- InlineResponse2012Studies
- InlineResponse2013
- InlineResponse2014
- InlineResponse2015
- InlineResponse2015Users
- InlineResponse2016
- InlineResponse2016Cells
- InlineResponse2016Choices
- InlineResponse2016Criteria
- InlineResponse2016Rows
- InlineResponse2017
- InlineResponse2017Files
- InlineResponse2017ReviewRequests
- InlineResponse2017Reviews
- InlineResponse2017Submissions
- InlineResponse2017Variables
- InlineResponse2018
- InlineResponse201AccessibilitySettings
- InlineResponse201ExerciseReviewers
- InlineResponse201GroupReviewers
- InlineResponse201Integrations
- InlineResponse201IntegrationsExamServices
- InlineResponse201IntegrationsOuriginal
- InlineResponse201IntegrationsProctorExam
- InlineResponse201IntegrationsProctorio
- InlineResponse201IntegrationsSchoolyear
- InlineResponse201IntegrationsStep
- InlineResponse201Requirements
- LabelsIdBody
- LocationsIdBody
- ObjectivesIdBody
- OneOfapiv2coursescourseIdassignmentsAccessibilitySettings1Calculator
- OneOfapiv2coursescourseIdassignmentsGradesSettings1GradeCalculation
- OneOfapiv2coursescourseIdassignmentsGradesSettings1Rounding
- OneOfapiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigBrowserViewMode
- OneOfapiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigChooseFileToUploadPolicy
- OneOfapiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigNewBrowserWindowByLinkPolicy
- OneOfapiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigPermittedProcessesOs
- OneOfapiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigProhibitedProcessesOs
- OneOfapiv2coursescourseIdassignmentsIntegrations1SafeExamBrowserConfigURLFilterRulesAction
- OneOfapiv2questionBanksquestionBankIdquestionBankAssignmentsGradesSettings1GradeCalculation
- OneOfapiv2questionBanksquestionBankIdquestionBankAssignmentsGradesSettings1Rounding
- OneOfapiv2schoolsschoolIdusersCoursesRole
- OneOfapiv2schoolsschoolIdusersQuestionBanksRole
- OneOfassignmentIdCoverBodyEnumerateExercises
- OneOfassignmentIdRequirementsBodyActionType
- OneOfassignmentsIdBodyAssignmentType
- OneOfbackgroundJobsIdBodyStatus
- OneOfcourseIdAssignmentsBodyAssignmentType
- OneOfcourseIdCoursesUsersBodyRole
- OneOfcoursesUsersIdBodyRole
- OneOfexerciseIdQuestionsBodyCategory
- OneOfexerciseIdQuestionsBodyChoiceType
- OneOfexerciseIdQuestionsBodyGradingType
- OneOfexerciseIdQuestionsBodyLayout
- OneOflabelsIdBodyColor
- OneOfquestionBankAssignmentIdCoverBodyEnumerateExercises
- OneOfquestionBankIdQuestionBankLabelsBodyColor
- OneOfquestionBankLabelsIdBodyColor
- OneOfquestionsIdBodyCategory
- OneOfquestionsIdBodyChoiceType
- OneOfquestionsIdBodyGradingType
- OneOfquestionsIdBodyLayout
- OneOfrequirementsIdBodyActionType
- OneOfschoolIdLabelsBodyColor
- OneOfschoolIdUsersBodyRole
- OneOfuserIdCoursesUsersBodyRole
- OneOfusersIdBodyRole
- OneOfv2CommentsBodyCommentableType
- PeriodsIdBody
- PlanIdSubscriptionsBody
- PlansIdBody
- PublicationTimeslotsIdBody
- PublisherIdPlansBody
- QuestionBankAssignmentIdCoverBody
- QuestionBankAssignmentIdScoreMarksBody
- QuestionBankAssignmentsIdBody
- QuestionBankExercisesIdBody
- QuestionBankIdDomainsBody
- QuestionBankIdQuestionBankAssignmentsBody
- QuestionBankIdQuestionBankExercisesBody
- QuestionBankIdQuestionBankLabelsBody
- QuestionBankIdTasksBody
- QuestionBankLabelsIdBody
- QuestionBanksIdBody
- QuestionsIdBody
- RequirementsIdBody
- ResultIdFilesBody
- ResultsIdBody
- SchoolIdClassesBody
- SchoolIdCoursesBody
- SchoolIdDepartmentsBody
- SchoolIdLabelsBody
- SchoolIdLocationsBody
- SchoolIdPeriodsBody
- SchoolIdUsersBody
- SchoolsIdBody
- ScoreMarksIdBody
- StudiesIdBody
- SubmissionsIdBody
- SubscriptionsIdBody
- TasksIdBody
- TimeslotsIdBody
- UserIdCoursesUsersBody
- UserIdGroupsUsersBody
- UsersIdBody
- V2CommentsBody
- V2QuestionBanksBody
- V2WebhooksBody
- WebhooksIdBody