This page is under construction
We’re working on it!

User Management
Institution Management
Instrument Management
UI Management

1. User Management

Set of API endpoints that allow users to be viewed or edited.

List Users
Create User
Read User
Update User
Update User Partial Information
Delete User

List Users: GET

API endpoint for listing Users.

Request

Concept	Data
HTTP Method	GET
Path	/api/v2/admin/user/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
search	string	A search term.
username	string	-
first_name	string	-
last_name	string	-
email	string	-
institution	string	-
roles	string	-
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer	-
next	string <uri> Nullable	-
previous	string <uri> Nullable	-
results `required`	Array of Objects (User)	-

Responses

Response sample

200

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    {
      "id": 0,
      "username": "string",
      "last_login": "2019-08-24T14:15:22Z",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "password": "string",
      "password2": "string",
      "institution": "string",
      "roles": "string",
      "institution_id": 0,
      "inst_admin": false,
      "login_allowed": true,
      "uid": "string",
      "is_superuser": true,
      "is_staff": true,
      "is_active": true,
      "date_joined": "2019-08-24T14:15:22Z",
      "groups": [
        0
      ],
      "user_permissions": [
        0
      ]
    }
  ]
}

Create User: POST

API endpoint that creates a new user. This endpoint is only available to admin users with the right admin permissions.

Request

Concept	Data
HTTP Method	POST
Path	/api/v2/admin/user/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

password2	string (Password2) non-empty Nullable	-
institution_id	integer (Institution id) Nullable	-
inst_admin	boolean (Inst admin) Nullable Default: false	-
login_allowed	boolean (Login allowed) Nullable Default: true	-
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
last_login <date-time>(Last login)	string	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
password	string (Password) non-empty Nullable	-
password2	string (Password2) non-empty Nullable	-
institution	string (Institution)	-
roles	string (Roles)	-
institution_id	integer (Institution id) Nullable	-
inst_admin	boolean (Inst admin) Nullable Default: false	-
login_allowed	boolean (Login allowed) Nullable Default: true	-
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Request Sample: POST

{
  "username": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "password": "string",
  "password2": "string",
  "institution_id": 0,
  "inst_admin": false,
  "login_allowed": true,
  "uid": "string",
  "is_superuser": true,
  "is_staff": true,
  "is_active": true,
  "date_joined": "2019-08-24T14:15:22Z",
  "groups": [
    0
  ],
  "user_permissions": [
    0
  ]
}

Responses

Response sample: 201

201

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "password": "string",
  "password2": "string",
  "institution": "string",
  "roles": "string",
  "institution_id": 0,
  "inst_admin": false,
  "login_allowed": true,
  "uid": "string",
  "is_superuser": true,
  "is_staff": true,
  "is_active": true,
  "date_joined": "2019-08-24T14:15:22Z",
  "groups": [
    0
  ],
  "user_permissions": [
    0
  ]
}

Read User

Retrieves information about a user.

Request

Concept	Data
HTTP method	GET
Path	/api/v2/admin/user/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter

Response parameters.

Name	Type	Comments
id	integer (ID) non-empty	-
username `required`	string (Username) non-empty	-
last_login	string <date-time> (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
password	string (Password) non-empty Nullable	-
password2	string (Password2) non-empty Nullable	-
institution	string (Institution)	-
roles	string (Roles)	-
institution_id	integer (Institution ID) Nullable	-
inst_admin	boolean (Inst admin) Nullable	Default: false
login_allowed	boolean(Login allowed) Nullable	Default: true
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Responses

Response sample: 200

200

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "password": "string",
  "password2": "string",
  "institution": "string",
  "roles": "string",
  "institution_id": 0,
  "inst_admin": false,
  "login_allowed": true,
  "uid": "string",
  "is_superuser": true,
  "is_staff": true,
  "is_active": true,
  "date_joined": "2019-08-24T14:15:22Z",
  "groups": [
    0
  ],
  "user_permissions": [
    0
  ]
}

Update User

Updates user’s information.

Request

Concept	Data
HTTP Method	PUT
Path	/api/v2/admin/user/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	-
username `required`	string (Username) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
password	string (Password) non-empty Nullable	-
password2	string (Password2) non-empty Nullable	-
institution_id	integer (Institution ID) Nullable	-
inst_admin	boolean (Inst admin) Nullable	Default: false
login_allowed	boolean(Login allowed) Nullable	Default: true
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
last_login	string <date-time&gr; (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
password	string (Password) non-empty Nullable	-
password2	string (Password2) non-empty Nullable	-
institution	string (Institution)	-
roles	string (Roles)	-
institution_id	integer (Institution ID) Nullable	-
inst_admin	boolean (Inst admin) Nullable	Default: false
login_allowed	boolean(Login allowed) Nullable	Default: true
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Responses

Response sample: 200

200

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "password": "string",
  "password2": "string",
  "institution": "string",
  "roles": "string",
  "institution_id": 0,
  "inst_admin": false,
  "login_allowed": true,
  "uid": "string",
  "is_superuser": true,
  "is_staff": true,
  "is_active": true,
  "date_joined": "2019-08-24T14:15:22Z",
  "groups": [
    0
  ],
  "user_permissions": [
    0
  ]
}

Update User Partial Information

Updates partial user’s information.

Request

Concept	Data
HTTP Method	PATCH
Path	/api/v2/admin/user/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	-
username `required`	string (Username) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
password	string (Password) non-empty Nullable	-
password2	string (Password2) non-empty Nullable	-
institution_id	integer (Institution ID) Nullable	-
inst_admin	boolean (Inst admin) Nullable	Default: false
login_allowed	boolean(Login allowed) Nullable	Default: true
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
last_login	string <date-time&gr; (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
password	string (Password) non-empty Nullable	-
password2	string (Password2) non-empty Nullable	-
institution	string (Institution)	-
roles	string (Roles)	-
institution_id	integer (Institution ID) Nullable	-
inst_admin	boolean (Inst admin) Nullable	Default: false
login_allowed	boolean(Login allowed) Nullable	Default: true
uid	string (Uid) non-empty Nullable	-
is_superuser	boolean (Superuser status)	Designates that this user has all permissions without explicitly assigning them.
is_staff	boolean (Staff status)	Designates whether the user can log into this admin site.
is_active	boolean (Active)	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
date_joined	string <date-time> (Date joined)	-
groups	Array of integers	The groups this user belongs to. A user will get all permissions granted to each of their groups.
user_permissions	Array of integers	Specific permissions for this user.

Responses

Response sample: 200

200

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "password": "string",
  "password2": "string",
  "institution": "string",
  "roles": "string",
  "institution_id": 0,
  "inst_admin": false,
  "login_allowed": true,
  "uid": "string",
  "is_superuser": true,
  "is_staff": true,
  "is_active": true,
  "date_joined": "2019-08-24T14:15:22Z",
  "groups": [
    0
  ],
  "user_permissions": [
    0
  ]
}

Delete User

Deletes user from the system.

Request

Concept	Data
HTTP Method	DELETE
Path	/api/v2/admin/user/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter

Responses

Response sample: 204

204

{
}

2. Institution Management

Set of API endpoints that allow an Institution to be viewed or edited.

GET: List Institutions
POST: Create Institution
GET: Read Institution
PUT: Update Institution
PATCH: Update Institution Partial Information
DELETE: Delete Institution

List Institutions: GET

API endpoint for listing Institutions.

Request

Concept	Data
HTTP Method	GET
Path	/api/v2/admin/institution/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
search	string	A search term
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer (ID)	-
next	string (uri) Nullable	-
previous	string (uri) Nullable	-
results `required`	Array of objects (InstitutionAdmin)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "acronym": "string",
    "name": "string",
    "external_ic": true,
    "mail_domain": "string",
    "disable_vle_learner_creation": true,
    "disable_vle_instructor_creation": true,
    "disable_vle_user_creation": true,
    "allow_learner_report": true,
    "allow_learner_audit": true,
    "allow_valid_audit": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

Create Institution

API endpoint for creating a new Institution.

Request

Concept	Data
HTTP Method	POST
Path	/api/v2/admin/institution/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.

Response parameters.

Name	Type	Comments
id	integer (Id)	Institution Id.
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.
created_at	string <date-time>(Created at)	-
updated_at	string <date-time>(Updated at)	-

Request Sample: POST

{
  "acronym": "string",
  "name": "string",
  "external_ic": true,
  "mail_domain": "string",
  "disable_vle_learner_creation": true,
  "disable_vle_instructor_creation": true,
  "disable_vle_user_creation": true,
  "allow_learner_report": true,
  "allow_learner_audit": true,
  "allow_valid_audit": true
}

Responses

Response sample

201

{
"id": 0,
"acronym": "string",
"name": "string",
"external_ic": true,
"mail_domain": "string",
"disable_vle_learner_creation": true,
"disable_vle_instructor_creation": true,
"disable_vle_user_creation": true,
"allow_learner_report": true,
"allow_learner_audit": true,
"allow_valid_audit": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Read Institution

Retrieves information about an Institution.

Request

Concept	Data
HTTP method	GET
Path	/api/v2/admin/institution/{institution_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
institution_id `required`	string	Request path parameter

Response parameters.

Name	Type	Comments
id	integer (Id)	Institution Id.
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.
created_at	string <date-time>(Created at)	-
updated_at	string <date-time>(Updated at)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "acronym": "string",
  "name": "string",
  "external_ic": true,
  "mail_domain": "string",
  "disable_vle_learner_creation": true,
  "disable_vle_instructor_creation": true,
  "disable_vle_user_creation": true,
  "allow_learner_report": true,
  "allow_learner_audit": true,
  "allow_valid_audit": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update Institution

API endpoint that updates Institution’s information.

Request

Concept	Data
HTTP method	PUT
Path	/api/v2/admin/institution/{institution_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
institution_id `required`	string	Request path parameter
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.

Response parameters.

Name	Type	Comments
id	integer (Id)	Institution Id.
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.
created_at	string <date-time>(Created at)	-
updated_at	string <date-time>(Updated at)	-

Request sample

{
  "acronym": "string",
  "name": "string",
  "external_ic": true,
  "mail_domain": "string",
  "disable_vle_learner_creation": true,
  "disable_vle_instructor_creation": true,
  "disable_vle_user_creation": true,
  "allow_learner_report": true,
  "allow_learner_audit": true,
  "allow_valid_audit": true
}

Responses

Response sample: 200

200

{
  "id": 0,
  "acronym": "string",
  "name": "string",
  "external_ic": true,
  "mail_domain": "string",
  "disable_vle_learner_creation": true,
  "disable_vle_instructor_creation": true,
  "disable_vle_user_creation": true,
  "allow_learner_report": true,
  "allow_learner_audit": true,
  "allow_valid_audit": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update Institution

API endpoint that updates Institution’s information.

Request

Concept	Data
HTTP method	PATCH
Path	/api/v2/admin/institution/{institution_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
institution_id `required`	string	Request path parameter
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.

Response parameters.

Name	Type	Comments
id	integer (Id)	Institution Id.
acronym `required`	string (Acronym) [1 .. 255] characters	Institution acronym
name `required`	string (Name) non-empty	Name of the institution
external_ic	boolean (External ic)	Informed Consent is managed externally to TeSLA
mail_domain	string (Mail domain) <= 255 characters. Nullable	Accepted mail domains for this institution.
disable_vle_learner_creation	boolean (Disable vle learner creation)	If enabled, VLEs cannot create learners.
disable_vle_instructor_creation	boolean (Disable vle instructor creation)	If enabled, VLEs cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLEs cannot create institution users.
allow_learner_report	boolean (Allow learner report)	Learners can access their reports.
allow_learner_audit	boolean (Allow learner audit)	Learners can access the audit data of their reports.
allow_valid_audit	boolean (Allow valid audit)	Audit data is available even when results are valid.
created_at	string <date-time>(Created at)	-
updated_at	string <date-time>(Updated at)	-

Request sample

{
  "acronym": "string",
  "name": "string",
  "external_ic": true,
  "mail_domain": "string",
  "disable_vle_learner_creation": true,
  "disable_vle_instructor_creation": true,
  "disable_vle_user_creation": true,
  "allow_learner_report": true,
  "allow_learner_audit": true,
  "allow_valid_audit": true
}

Responses

Response sample: 200

200

{
  "id": 0,
  "acronym": "string",
  "name": "string",
  "external_ic": true,
  "mail_domain": "string",
  "disable_vle_learner_creation": true,
  "disable_vle_instructor_creation": true,
  "disable_vle_user_creation": true,
  "allow_learner_report": true,
  "allow_learner_audit": true,
  "allow_valid_audit": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete Institution

API endpoint for deleting Institution from the system.

Request

Concept	Data
HTTP Method	DELETE
Path	/api/v2/admin/institution/{institution_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
institution_id `required`	string	Request path parameter

Responses

Response sample: 204

204

{
}

3. Instrument Management

Set of API endpoints that allow an Instrument to be viewed or edited.

GET: List Instruments
POST: Create Instrument
GET: Read Instrument
PUT: Update Instrument
PATCH: Update Instrument Partial Information
DELETE: Delete Instrument

List Instruments [GET]

API endpoint for listing all Instruments.

Request

Concept	Data
HTTP Method	GET
Path	/api/v2/admin/instrument/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
search	string	A search term
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer (ID)	-
next	string (uri) Nullable	-
previous	string (uri) Nullable	-
results `required`	Array of objects (Instrument)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "options_schema": {},
    "name": "string",
    "acronym": "string",
    "queue": "string",
    "enabled": true,
    "requires_enrolment": true,
    "description": "string",
    "identity": true,
    "originality": true,
    "authorship": true,
    "integrity": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

Create Instrument [POST]

API endpoint for creating a new Instrument.

Request

Concept	Data
HTTP Method	POST
Path	/api/v2/admin/instrument/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request Sample: POST

{
  "options_schema": {},
  "name": "string",
  "acronym": "string",
  "queue": "string",
  "enabled": true,
  "requires_enrolment": true,
  "description": "string",
  "identity": true,
  "originality": true,
  "authorship": true,
  "integrity": true
}

Responses

Response sample

201

{
"id": 0,
"options_schema": {},
"name": "string",
"acronym": "string",
"queue": "string",
"enabled": true,
"requires_enrolment": true,
"description": "string",
"identity": true,
"originality": true,
"authorship": true,
"integrity": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Read Instrument [GET]

Retrieves information about an Instrument.

Request

Concept	Data
HTTP method	GET
Path	/api/v2/admin/instrument/{instrument_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
instrument_id `required`	string	Request path parameter. A unique integer value identifying this instrument.

Response parameters.

Name	Type	Comments
id	integer (Id)	Instrument Id.
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "options_schema": {},
  "name": "string",
  "acronym": "string",
  "queue": "string",
  "enabled": true,
  "requires_enrolment": true,
  "description": "string",
  "identity": true,
  "originality": true,
  "authorship": true,
  "integrity": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update Instrument [PUT]

API endpoint that updates Instrument’s information.

Request

Concept	Data
HTTP method	PUT
Path	/api/v2/admin/instrument/{instrument_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
instrument_id `required`	string	Request path parameter. A unique integer value identifying this instrument.
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.

Response parameters.

Name	Type	Comments
id	integer (Id)	Instrument Id.
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "options_schema": {},
  "name": "string",
  "acronym": "string",
  "queue": "string",
  "enabled": true,
  "requires_enrolment": true,
  "description": "string",
  "identity": true,
  "originality": true,
  "authorship": true,
  "integrity": true
}

Responses

Response sample: 200

200

{
  "id": 0,
  "options_schema": {},
  "name": "string",
  "acronym": "string",
  "queue": "string",
  "enabled": true,
  "requires_enrolment": true,
  "description": "string",
  "identity": true,
  "originality": true,
  "authorship": true,
  "integrity": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update Instrument Partial Information [PATCH]

API endpoint that updates Instrument’s information.

Request

Concept	Data
HTTP method	PATCH
Path	/api/v2/admin/instrument/{instrument_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
instrument_id `required`	string	Request path parameter. A unique integer value identifying this instrument.
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.

Response parameters.

Name	Type	Comments
id	integer (Id)	Instrument Id.
options_schema	object (Options schema) Nullable	-
name `required`	string (Name) [1 .. 250] characters	Instrument name
acronym `required`	string (Acronym) [1 .. 30] characters	Instrument acronym
queue `required`	string (Queue) non-empty	Queue this instrument listens to.
enabled	boolean (Enabled)	The instrument is enabled.
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
description	string (Description) Nullable	Description of the instrument.
identity	boolean (Identity)	This instrument contributes to the learner identity verification.
originality	boolean (Originality)	This instrument contributes to the assessment originality verification.
authorship	boolean (Authorship)	This instrument contributes to the assessment authorship verification.
integrity	boolean (Integrity)	This instrument contributes to the assessment integrity verification.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "options_schema": {},
  "name": "string",
  "acronym": "string",
  "queue": "string",
  "enabled": true,
  "requires_enrolment": true,
  "description": "string",
  "identity": true,
  "originality": true,
  "authorship": true,
  "integrity": true
}

Responses

Response sample: 200

200

{
  "id": 0,
  "options_schema": {},
  "name": "string",
  "acronym": "string",
  "queue": "string",
  "enabled": true,
  "requires_enrolment": true,
  "description": "string",
  "identity": true,
  "originality": true,
  "authorship": true,
  "integrity": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete Instrument [DELETE]

API endpoint for deleting Instrument from the system.

Request

Concept	Data
HTTP Method	DELETE
Path	/api/v2/admin/instrument/{instrument_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
instrument_id `required`	integer	Request path parameter. A unique integer value identifying this instrument.

Responses

Response sample: 204

204

{
}

4. UI Management

Set of API endpoints that allow a UI to be viewed or edited.

List UI (GET)
Create UI (POST)
Read UI (GET)
Update UI (PUT)
Update UI Partial Information (PATCH)
Delete UI (DELETE)

List UI (GET)

API endpoint for listing UI.

Request

Concept	Data
HTTP method	GET
Path	/api/v2/admin/ui/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
search	string	A search term.
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer (ID)	-
next	string (uri) Nullable	-
previous	string (uri) Nullable	-
results `required`	Array of objects (Instrument)	-

Responses

Response sample: 200

200

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    {
      "id": "string",
      "route": "string",
      "enabled": true,
      "roles": "string"
    }
  ]
}

Create UI (POST)

API endpoint for creating a new UI.

Request

Concept	Data
HTTP method	POST
Path	/api/v2/admin/ui/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Response parameters.

Name	Type	Comments
ui_id	string (Id)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Request sample

{
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Responses

Response sample: 201

201

{
  "id": "string",
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Read UI (GET)

Retrieves information about UI Options.

Request

Concept	Data
HTTP method	GET
Path	/api/v2/admin/ui/{ui_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
ui_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
ui_id	string (Id)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Responses

Response sample: 200

200

{
  "id": "string",
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Update UI (PUT)

API endpoint that updates UI Options’ information.

Request

Concept	Data
HTTP method	PUT
Path	/api/v2/admin/ui/{ui_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
ui_id `required`	string	Request path parameter.
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Response parameters.

Name	Type	Comments
ui_id	string (Id)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Request sample

{
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Responses

Response sample: 200

200

{
  "id": "string",
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Update UI Partial Information (PATCH)

API endpoint that updates UI Options’ information.

Request

Concept	Data
HTTP method	PATCH
Path	/api/v2/admin/ui/{ui_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
ui_id `required`	string	Request path parameter.
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Response parameters.

Name	Type	Comments
ui_id	string (Id)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles) <=250 characters. Nullable	Required roles.

Request sample

{
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Responses

Response sample: 200

200

{
  "id": "string",
  "route": "string",
  "enabled": true,
  "roles": "string"
}

Delete UI (DELETE)

API endpoint for deleting UI Options from the system.

Request

Concept	Data
HTTP Method	DELETE
Path	/api/v2/admin/ui/{ui_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
ui_id `required`	string	Request path parameter. .

Responses

Response sample: 204

204

{
}

Admin

Table of Contents

1. User Management

List Users: GET

Request

Parameters

Responses

Response sample

Create User: POST

Request

Parameters:

Request Sample: POST

Responses

Response sample: 201

Read User

Request

Parameters:

Responses

Response sample: 200

Update User

Request

Parameters:

Responses

Response sample: 200

Update User Partial Information

Request

Parameters:

Responses

Response sample: 200

Delete User

Request

Parameters:

Responses

Response sample: 204

2. Institution Management

List Institutions: GET

Request

Parameters

Responses

Response sample

Create Institution

Request

Parameters

Request Sample: POST

Responses

Response sample

Read Institution

Request

Parameters:

Responses

Response sample: 200

Update Institution

Request

Parameters:

Request sample

Responses

Response sample: 200

Update Institution

Request

Parameters:

Request sample

Responses

Response sample: 200

Delete Institution

Request

Parameters:

Responses

Response sample: 204

3. Instrument Management

List Instruments [GET]

Request

Parameters

Responses

Response sample

Create Instrument [POST]

Request

Parameters

Request Sample: POST

Responses

Response sample