My API Docs
api
courses > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
university | |
college | |
search | A search term. |
ordering | Which field to use when ordering the results. |
courses > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
university required | |
specialist | |
college required | |
title required | |
price required | |
description required | |
image | |
date |
courses > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this course. |
courses > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this course. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
university required | |
specialist | |
college required | |
title required | |
price required | |
description required | |
image | |
date |
courses > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this course. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
university | |
specialist | |
college | |
title | |
price | |
description | |
image | |
date |
courses > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this course. |
courses > enrolled-students > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required |
courses > enrolled-students > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this enrollment. |
courses > enrolled-students > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this enrollment. |
courses > lectures > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required |
courses > lectures > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required |
courses > lectures > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this lecture. |
courses > lectures > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this lecture. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required |
courses > lectures > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this lecture. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title |
courses > lectures > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this lecture. |
courses > lectures > files > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required |
courses > lectures > files > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file required |
courses > lectures > files > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this file content. |
courses > lectures > files > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this file content. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file required |
courses > lectures > files > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this file content. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file |
courses > lectures > files > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this file content. |
courses > lectures > videos > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required |
courses > lectures > videos > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
url required |
courses > lectures > videos > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this video content. |
courses > lectures > videos > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this video content. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
url required |
courses > lectures > videos > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this video content. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
url |
courses > lectures > videos > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
lec_pk required | |
id required | A UUID string identifying this video content. |
courses > requests > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required |
courses > requests > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status |
courses > requests > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this request. |
courses > requests > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this request. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status |
courses > requests > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this request. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status |
courses > requests > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_pk required | |
id required | A UUID string identifying this request. |
professors > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
university | |
college | |
search | A search term. |
ordering | Which field to use when ordering the results. |
professors > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this professor. |
professors > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this professor. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
university required | |
specialist | |
college required | |
bio |
professors > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this professor. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
university | |
specialist | |
college | |
bio |
professors > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this professor. |
auth
facebook > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
access_token | |
code | |
id_token |
google > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
access_token | |
code | |
id_token |
login > create
Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework
Accept the following POST parameters: username, password Return the REST Framework Token Object's key.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username | |
email | |
password required |
logout > list
Calls Django logout method and delete the Token object assigned to the current User object.
Accepts/Returns nothing.
logout > create
Calls Django logout method and delete the Token object assigned to the current User object.
Accepts/Returns nothing.
password > change > create
Calls Django Auth SetPasswordForm save method.
Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
old_password required | |
new_password1 required | |
new_password2 required |
password > reset > create
Calls Django Auth PasswordResetForm save method.
Accepts the following POST parameters: email Returns the success/fail message.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required |
password > reset > confirm > create
Password reset e-mail link is confirmed, therefore this resets the user's password.
Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
new_password1 required | |
new_password2 required | |
uid required | |
token required |
registration > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | |
email required | |
password1 required | |
password2 required | |
role required | |
phone_number required |
registration > account-confirm-email > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
key required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
key required |
registration > resend-email > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required |
registration > verify-email > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
key required |
token > refresh > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
refresh | WIll override cookie. |
token > verify > create
Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
token required |
user > read
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.
Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email
Returns UserModel fields.
user > update
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.
Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email
Returns UserModel fields.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
first_name | |
last_name | |
username required | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
phone_number | |
profile_image |
user > partial_update
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.
Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email
Returns UserModel fields.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
first_name | |
last_name | |
username | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
phone_number | |
profile_image |