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

Institution Management
Institution VLE Management
Institution Course Management
Institution Group Management
Institution Group Courses Management
Institution IC Management
Institution IC Document Management
Institution Instrument Management
Institution UI Management
Institution User Management
Institution Instructor Managament
Institution Learner Management
Institution SEND Management
Institution learner SEND Management
Institution Course Instructor Management
Institution Course Learner Management
Institution Course Activity Management
Institution Course Activity Instrument Management
Institution Course Activity Report Management
Institution Course Activity Report Request Management
Institution Course Activity Report Audit Management

1. Institution Management

Set of API endpoint that allows access to institution data.

1.1 GET: List Institution
1.2 GET: Read Institution
1.3 PUT: Update Institution
1.4 PATCH: Partial Update Institution

1.1 List Institution

API endpoint that allows access to institution data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (Institution)	-

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"
  }
]
}

[top section] [top page]

1.2 Read Institution

API endpoint that allows access to institution data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/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)	-
acronym	string (Acronym) non-empty	-
name	string (Name) non-empty	-
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, VLE cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLE 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

{
"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"
}

[top section] [top page]

1.3 Update Institution

API endpoint that allows institution data update.

Request

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

Parameters

Request parameters.

Name	Type	Comments
institution_id `required`	string	Request path parameter.
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, VLE cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLE 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)	-
acronym	string (Acronym) non-empty	-
name	string (Name) non-empty	-
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, VLE cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLE 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

{
  "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

{
"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"
}

[top section] [top page]

1.4 Partial Update Institution

API endpoint that allows institution data update.

Request

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

Parameters

Request parameters.

Name	Type	Comments
institution_id `required`	string	Request path parameter.
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, VLE cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLE 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)	-
acronym	string (Acronym) non-empty	-
name	string (Name) non-empty	-
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, VLE cannot create instructors.
disable_vle_user_creation	boolean (Disable vle user creation)	If enabled, VLE 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

{
  "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

{
"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"
}

[top section] [top page]

2. Institution VLE Management

Set of API endpoint that allows access to Institution VLE data.

2.1 GET: List Institution VLE
2.2 POST: Create Institution VLE
2.3 GET: Read Institution VLE
2.4 PUT: Update Institution VLE
2.5 PATCH: Partial Update Institution VLE
2.6 DEL: Delete Institution VLE

[top page]

2.1 List Institution VLE

API endpoint that allows access to Institution VLE data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/vle/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionVLE)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "type": 0,
    "lti": {},
    "name": "string",
    "credentials": "string",
    "url": "string",
    "client_id": "string"
  }
]
}

[top section] [top page]

2.2 Create Institution VLE

API endpoint that creates Institution VLE.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/vle/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
type `required`	integer (Type)	Value: 0
name `required`	string (Name) non-empty	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
type `required`	integer (Type)	Value: 0
lti	object (Lti)	-
name `required`	string (Name) non-empty	-
credentials	string (Credentials)	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Request sample

{
  "type": 0,
  "name": "string",
  "url": "string",
  "client_id": "string"
}

Responses

Response sample

201

{
  "id": 0,
  "type": 0,
  "lti": {},
  "name": "string",
  "credentials": "string",
  "url": "string",
  "client_id": "string"
}

[top section] [top page]

2.3 Read Institution VLE

API endpoint that allows access to Institution VLE data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/vle/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
type `required`	integer (Type)	Value: 0
lti	object (Lti)	-
name `required`	string (Name) non-empty	-
credentials	string (Credentials)	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Responses

Response sample

200

{
  "id": 0,
  "type": 0,
  "lti": {},
  "name": "string",
  "credentials": "string",
  "url": "string",
  "client_id": "string"
}

[top section] [top page]

2.4 Update Institution VLE

API endpoint that updates Institution VLE data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/vle/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
type `required`	integer (Type)	Value: 0
name `required`	string (Name) non-empty	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
type `required`	integer (Type)	Value: 0
lti	object (Lti)	-
name `required`	string (Name) non-empty	-
credentials	string (Credentials)	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Request sample

{
  "type": 0,
  "name": "string",
  "url": "string",
  "client_id": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "type": 0,
  "lti": {},
  "name": "string",
  "credentials": "string",
  "url": "string",
  "client_id": "string"
}

[top section] [top page]

2.5 Partial Update Institution VLE

API endpoint that updates Institution VLE data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/vle/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
type `required`	integer (Type)	Value: 0
name `required`	string (Name) non-empty	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
type `required`	integer (Type)	Value: 0
lti	object (Lti)	-
name `required`	string (Name) non-empty	-
credentials	string (Credentials)	-
url	string (Url) Nullable.	VLE url.
client_id	string (Client id) [1 .. 250] characters Nullable.	LTI 1.3 Client ID.

Request sample

{
"type": 0,
"name": "string",
"url": "string",
"client_id": "string"
}

Responses

Response sample

200

{
"id": 0,
"type": 0,
"lti": {},
"name": "string",
"credentials": "string",
"url": "string",
"client_id": "string"
}

[top section] [top page]

2.6 Delete Institution VLE

API endpoint that deletes Institution VLE.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/vle/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

3. Institution Course Management

Set of API endpoint that allows access to Institution Course data.

3.1 GET: List Institution Course
3.3 GET: Read Institution Course

[top page]

3.1 List Institution Course

API endpoint that allows Institution Courses list.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionCourse)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "vle": {
      "id": 0,
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "vle_course_id": "string",
    "code": "string",
    "description": "string",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "user_roles": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

3.2 Read Institution Course

API endpoint that allows access to Institution Course data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id `required`	integer (Id)	-
vle	object (VLE)	-
vle_course_id	string (VLE Course ID) non-empty	-
code	string (Code) non-empty	-
description	string (Description) non-empty	-
start	string <date-time> (Start)	-
end	string <date-time> (End)	-
user_roles	string (User roles)	-
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "vle": {
    "id": 0,
    "type": "string",
    "name": "string",
    "url": "string",
    "client_id": "string"
  },
  "vle_course_id": "string",
  "code": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "user_roles": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

4. Institution Group Management

Set of API endpoint that allows Course Groups to be viewed or edited.

4.1 GET: List Institution Group
4.2 POST: Create Institution Group
4.3 GET: Read Institution Group
4.4 PUT: Update Institution Group
4.5 PATCH: Partial Update Institution Group
4.6 DEL: Delete Institution Group

[top page]

4.1 List Institution Group

API endpoint that lists exisiting Course Groups.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
name	string	-
description	string	-
parent	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 (InstitutionCourseGroup)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "institution": {
      "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"
    },
    "parent": 0,
    "name": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

4.2 Create Institution Group

API endpoint that creates Course Group.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "parent": 0,
  "name": "string",
  "description": "string"
}

Responses

Response sample

201

{
  "id": 0,
  "institution": {
    "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"
  },
  "parent": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

4.3 Read Institution Group

API endpoint that allows access to a Course Group data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "parent": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

4.4 Update Institution Group

API endpoint that updates Course Group data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "parent": 0,
  "name": "string",
  "description": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "parent": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

4.5 Partial Update Institution Group

API endpoint that updates Course Group data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
parent	integer (Parent) Nullable.	-
name `required`	string (Name) [1 .. 250] characters	Group name.
description	string (Description) Nullable.	Group description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "parent": 0,
  "name": "string",
  "description": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "parent": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

4.6 Delete Institution Group

API endpoint that deletes Course Group.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

5. Institution Group Courses Management

Set of API endpoint that allows Courses in Course Groups to be added or deleted.

5.1 GET: List Institution Group Courses
5.2 POST: Create Institution Group Courses
5.3 GET: Read Institution Group Courses
5.4 PUT: Update Institution Group Courses
5.5 PATCH: Partial Update Institution Group Courses
5.6 DEL: Delete Institution Group Courses

[top page]

5.1 List Institution Group Courses

API endpoint that lists Courses in a Course Group.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{parent_lookup_id}/course/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
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 (InstitutionCourseGroupCourse)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "vle_id": 0,
    "vle_course_id": "string",
    "code": "string",
    "description": "string",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

5.2 Create Institution Group Courses

API endpoint that adds Course to a Course Group.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{parent_lookup_id}/course/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
id `required`	integer (Id)	-

Response parameters.

Name	Type	Comments
id `required`	integer (ID)	-
vle_id	integer (VLE ID)	-
vle_course_id	string (VLE Course ID) non-empty	-
code	string (Code) non-empty	-
description	string (Description) non-empty	-
start	string <date-time> (Start)	-
end	string <date-time> (End)	-
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "id": 0
}

Responses

Response sample

201

{
  "id": 0,
  "vle_id": 0,
  "vle_course_id": "string",
  "code": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.3 Read Institution Group Courses

API endpoint that allows access to Course data from a Course Group.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{parent_lookup_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id `required`	integer (ID)	-
vle_id	integer (VLE ID)	-
vle_course_id	string (VLE Course ID) non-empty	-
code	string (Code) non-empty	-
description	string (Description) non-empty	-
start	string <date-time> (Start)	-
end	string <date-time> (End)	-
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "vle_id": 0,
  "vle_course_id": "string",
  "code": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.4 Update Institution Group Courses

API endpoint that updates Course data from a Course Group .

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{parent_lookup_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
id `required`	integer (ID)	-

Response parameters.

Name	Type	Comments
id `required`	integer (ID)	-
vle_id	integer (VLE ID)	-
vle_course_id	string (VLE Course ID) non-empty	-
code	string (Code) non-empty	-
description	string (Description) non-empty	-
start	string <date-time> (Start)	-
end	string <date-time> (End)	-
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "id": 0
}

Responses

Response sample

200

{
  "id": 0,
  "vle_id": 0,
  "vle_course_id": "string",
  "code": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.5 Partial Update Institution Group Courses

API endpoint that updates Course data from a Course Group .

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{parent_lookup_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
id `required`	integer (ID)	-

Response parameters.

Name	Type	Comments
id `required`	integer (ID)	-
vle_id	integer (VLE ID)	-
vle_course_id	string (VLE Course ID) non-empty	-
code	string (Code) non-empty	-
description	string (Description) non-empty	-
start	string <date-time> (Start)	-
end	string <date-time> (End)	-
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "id": 0
}

Responses

Response sample

200

{
  "id": 0,
  "vle_id": 0,
  "vle_course_id": "string",
  "code": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.6 Delete Institution Group Courses

API endpoint that deletes course in a Course Group.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/group/{parent_lookup_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

6. Institution IC Management

Set of API endpoint that allows Informed Consent to be viewed or edited.

6.1 GET: List Institution IC
6.2 POST: Create Institution IC
6.3 GET: Current Institution IC
6.4 GET: Read Institution IC
6.5 PUT: Update Institution IC
6.6 PATCH: Partial Update Institution IC
6.7 DEL: Delete Institution IC

[top page]

6.1 List Institution IC

API endpoint that lists Informed Consent in an Institution.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionInformedConsent)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "institution": {
      "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"
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

6.2 Create Institution IC

API endpoint that adds Informed Consent to an Institution.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z"
}

Responses

Response sample

201

{
  "id": 0,
  "institution": {
    "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"
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.3 Current Institution IC

API endpoint that retrieves the current Informed Consent.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/current/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionInformedConsent)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "institution": {
      "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"
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

6.4 Read Institution IC

API endpoint for reading an Informed Consent.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.5 Update Institution IC

API endpoint that updates Informed Consent data in an Institution.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z"
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.6 Partial Update Institution IC

API endpoint that updates Informed Consent data in an Institution.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
version `required`	string (Version) [1 .. 250] characters	Informed Consent version.
valid_from `required`	string <date-time> (Valid from)	Informed Consent valid from.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z"
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "version": "string",
  "valid_from": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.7 Delete Institution IC

API endpoint that deletes Informed Consent from an Institution.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

7. Institution IC Document Management

Set of API endpoint that allows Informed Consent Document to be viewed or edited.

7.1 GET: List Institution IC Document
7.2 POST: Create Institution IC Document
7.3 GET: Read Institution IC Document
7.4 PUT: Update Institution IC Document
7.5 PATCH: Partial Update Institution IC Document
7.6 DEL: Delete Institution IC Document

[top page]

7.1 List Institution IC Document

API endpoint that lists Informed Consent Documents.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{parent_lookup_informed_consent_id}/document/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_informed_consent_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionInformedConsent)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "consent": {
      "id": 0,
      "institution": {
        "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"
      },
      "version": "string",
      "valid_from": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "language": "string",
    "html": "string",
    "pdf": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

7.2 Create Institution IC Document

API endpoint that creates an Informed Consent Document.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{parent_lookup_informed_consent_id}/document/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_informed_consent_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.
pdf	string <uri> (Pdf) Nullable.	PDF version of IC.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "consent": {
    "institution": {
      "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
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z"
  },
  "language": "string",
  "html": "string"
}

Responses

Response sample

201

{
"id": 0,
"consent": {
"id": 0,
"institution": {},
"version": "string",
"valid_from": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"language": "string",
"html": "string",
"pdf": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

7.3 Read Institution IC Document

API endpoint for reading an Informed Consent Document.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{parent_lookup_informed_consent_id}/document/{language}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
language `required`	string	Request path parameter.
parent_lookup_informed_consent_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.
pdf	string <uri> (Pdf) Nullable.	PDF version of IC.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "consent": {
    "id": 0,
    "institution": {
      "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"
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "language": "string",
  "html": "string",
  "pdf": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

7.4 Update Institution IC Document

API endpoint that updates Informed Consent Document.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{parent_lookup_informed_consent_id}/document/{language}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
language `required`	string	Request path parameter.
parent_lookup_informed_consent_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.
pdf	string <uri> (Pdf) Nullable.	PDF version of IC.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "consent": {
    "institution": {
      "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
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z"
  },
  "language": "string",
  "html": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "consent": {
    "id": 0,
    "institution": {
      "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"
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "language": "string",
  "html": "string",
  "pdf": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

7.5 Partial Update Institution IC Document

API endpoint that updates Informed Consent Document.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{parent_lookup_informed_consent_id}/document/{language}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
language `required`	string	Request path parameter.
parent_lookup_informed_consent_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
consent	object (InstitutionInformedConsent)	-
language `required`	string (Language) [1 .. 30] characters	-
html	string (Html) Nullable.	HMTL version of IC.
pdf	string <uri> (Pdf) Nullable.	PDF version of IC.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "consent": {
    "institution": {
      "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
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z"
  },
  "language": "string",
  "html": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "consent": {
    "id": 0,
    "institution": {
      "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"
    },
    "version": "string",
    "valid_from": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "language": "string",
  "html": "string",
  "pdf": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

7.6 Delete Institution IC Document

API endpoint that deletes Informed Consent Document.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/ic/{parent_lookup_informed_consent_id}/document/{language}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
language `required`	string	Request path parameter.
parent_lookup_informed_consent_id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

8. Institution Instrument Management

Set of API endpoint that allows read Instrument data.

8.1 GET: List Institution Instrument
8.2 GET: Read Institution Instrument

[top page]

8.1 List Institution Instrument

API endpoint that lists Institution Instruments.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/instrument/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
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"
  }
]
}

[top section] [top page]

8.2 Read Institution Instrument

API endpoint that allows read Instrument data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/instrument/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

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.
	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)	-
created_at	string <date-time> (Created at)	-

Responses

Response sample

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"
}

[top section] [top page]

9. Institution UI Management

Set of API endpoint that allows Institution UI Options to be viewed or edited.

9.1 GET: List Institution UI
9.2 POST: Create Institution UI
9.3 GET: Read Institution UI
9.4 PUT: Update Institution UI
9.5 PATCH: Partial Update Institution UI
9.6 DEL: Delete Institution UI

[top page]

9.1 List Institution UI

API endpoint that allows access to Institution UI data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ui/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionUIOption)	-

Responses

Response sample

200

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

[top section] [top page]

9.2 Create Institution UI

API endpoint that creates Institution UI.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/ui/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
user	string (User) Nullable.	Affected User.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles)	Affected User.
user	string (User) Nullable.	Affected User.
is_global	string (Is global)	-

Request sample

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

Responses

Response sample

201

{
  "id": 0,
  "route": "string",
  "enabled": true,
  "roles": "string",
  "user": "string",
  "is_global": "string"
}

[top section] [top page]

9.3 Read Institution UI

API endpoint that allows access to Institution UI data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/ui/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles)	Affected User.
user	string (User) Nullable.	Affected User.
is_global	string (Is global)	-

Responses

Response sample

200

{
  "id": 0,
  "route": "string",
  "enabled": true,
  "roles": "string",
  "user": "string",
  "is_global": "string"
}

[top section] [top page]

9.4 Update Institution UI

API endpoint that updates Institution UI data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/ui/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
user	string (User) Nullable.	Affected User.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles)	Affected User.
user	string (User) Nullable.	Affected User.
is_global	string (Is global)	-

Request sample

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

Responses

Response sample

200

{
  "id": 0,
  "route": "string",
  "enabled": true,
  "roles": "string",
  "user": "string",
  "is_global": "string"
}

[top section] [top page]

9.5 Partial Update Institution UI

API endpoint that updates Institution UI data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/ui/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
user	string (User) Nullable.	Affected User.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
route `required`	string (Route) [1 .. 250] characters	Affected Route.
enabled	boolean (Enabled)	Status.
roles	string (Roles)	Affected User.
user	string (User) Nullable.	Affected User.
is_global	string (Is global)	-

Request sample

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

Responses

Response sample

200

{
  "id": 0,
  "route": "string",
  "enabled": true,
  "roles": "string",
  "user": "string",
  "is_global": "string"
}

[top section] [top page]

9.6 Delete Institution UI

API endpoint that deletes Institution UI.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/ui/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

10. Institution User Management

Set of API endpoint that allows Institution Users to be managed.

10.1 GET: List Institution User
10.2 POST: Create Institution User
10.3 GET: Read Institution User
10.4 PUT: Update Institution User
10.5 PATCH: Partial Update Institution User
10.6 DEL: Delete Institution User

[top page]

10.1 List Institution User

API endpoint that allows Institution Users to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/user/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
search	string	A search term
username	string	-
first_name	string	-
last_name	string	-
email	string	-
roles	string	-
uid	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 (InstitutionUser)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "username": "string",
    "password": "string",
    "password2": "string",
    "last_login": "2019-08-24T14:15:22Z",
    "first_name": "string",
    "last_name": "string",
    "uid": "string",
    "email": "user@example.com",
    "locale": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "inst_admin": true,
    "legal_admin": true,
    "send_admin": true,
    "data_admin": true
  }
]
}

[top section] [top page]

10.2 Create Institution User

API endpoint that creates Institution User.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/user/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
last_login	string <date-time> (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Request sample

{
  "username": "string",
  "password": "string",
  "password2": "string",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

201

{
  "id": 0,
  "username": "string",
  "password": "string",
  "password2": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

10.3 Read Institution User

API endpoint that allows access to Institution User data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/user/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
last_login	string <date-time> (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "password": "string",
  "password2": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

10.4 Update Institution User

API endpoint that updates Institution User data.

Request

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

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
last_login	string <date-time> (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Request sample

{
  "username": "string",
  "password": "string",
  "password2": "string",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "password": "string",
  "password2": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

10.5 Partial Update Institution User

API endpoint that updates Institution User data.

Request

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

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username `required`	string (Username) non-empty	-
password	string (Password) non-empty Nullable.	-
password2	string (Password2) non-empty Nullable.	-
last_login	string <date-time> (Last login)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
uid `required`	string (Uid) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Request sample

{
  "username": "string",
  "password": "string",
  "password2": "string",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "password": "string",
  "password2": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "uid": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

10.6 Delete Institution User

API endpoint that deletes Institution User.

Request

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

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

11. Institution Instructor Management

Set of API endpoint that allows Institution Instructors to be viewed or edited.

11.1 GET: List Institution Instructor
11.2 POST: Create Institution Instructor
11.3 GET: Read Institution Instructor
11.4 PUT: Update Institution Instructor
11.5 PATCH: Partial Update Institution Instructor
11.6 DEL: Delete Institution Instructor

[top page]

11.1 List Institution Instructor

API endpoint that allows Institution Instructors to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/instructor/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionInstructor)	-

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",
    "locale": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "uid": "string",
    "inst_admin": true,
    "legal_admin": true,
    "send_admin": true,
    "data_admin": true
  }
]
}

[top section] [top page]

11.2 Create Institution Instructor

API endpoint that creates Institution Instructor.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/instructor/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	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	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Request sample

{
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

201

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

11.3 Read Institution Instructor

API endpoint that allows access to Institution Instructor data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	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	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the Institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

11.4 Update Institution Instructor

API endpoint that updates Institution Instructor data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
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	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Request sample

{
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

11.5 Partial Update Institution Instructor

API endpoint that updates Institution Instructor data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
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	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Request sample

{
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

[top section] [top page]

11.6 Delete Institution Instructor

API endpoint that deletes Institution Instructor.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

12. Institution Learner Management

Set of API endpoint that allows Institution Learners to be viewed or edited.

12.1 GET: List Institution Learner
12.2 POST: Create Institution Learner
12.3 GET: Read Institution Learner
12.4 PUT: Update Institution Learner
12.5 PATCH: Partial Update Institution Learner
12.6 DEL: Delete Institution Learner
12.7 GET: Enrolment Institution Learner
12.8 POST: Create Institution Learner IC
12.9 DEL: Delete Institution Learner IC

[top page]

12.1 List Institution Learner

API endpoint that allows Institution Learners to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionLearner)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "institution": {
      "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"
    },
    "username": "string",
    "consent": {
      "version": "string",
      "status": "string"
    },
    "consent_accepted": "2019-08-24T14:15:22Z",
    "consent_rejected": "2019-08-24T14:15:22Z",
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "last_login": "2019-08-24T14:15:22Z",
    "send": {},
    "email": "user@example.com",
    "ic_status": "string",
    "login_allowed": false,
    "first_name": "string",
    "last_name": "string",
    "locale": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "uid": "string",
    "inst_admin": true,
    "legal_admin": true,
    "send_admin": true,
    "data_admin": true,
    "joined_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

12.2 Create Institution Learner

API endpoint that creates Institution Learner.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
consent	object (InstitutionLearnerConsent) Nullable.	-
email `required`	string <email> (Email) non-empty	-
first_name	string (First name) <= 150 characters	-
last_name	string (Last name) <= 150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email `required`	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "consent": {
    "version": "string"
  },
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

201

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

12.3 Read Institution Learner

API endpoint that allows access to Institution Learner data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email `required`	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

12.4 Update Institution Learner

API endpoint that updates Institution Learner data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
consent	object (InstitutionLearnerConsent) Nullable.	-
email `required`	string <email> (Email) non-empty	-
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email `required`	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "consent": {
    "version": "string"
  },
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

12.5 Partial Update Institution Learner

API endpoint that updates Institution Learner data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
consent	object (InstitutionLearnerConsent) Nullable.	-
email `required`	string <email> (Email) non-empty	-
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email `required`	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "consent": {
    "version": "string"
  },
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

12.6 Delete Institution Learner

API endpoint that deletes Institution Learner.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

12.7 Enrolment Institution Learner

API endpoint that allows learner enrolment status to be viewed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/enrolment/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email `required`	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

12.8 Create Institution Learner IC

API endpoint that manages learner informed consent.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/ic/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
consent	object (InstitutionLearnerConsent) Nullable.	-
email `required`	string <email> (Email) non-empty	-
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email `required`	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
first_name	string (First name) <=150 characters>	-
last_name	string (Last name) <=150 characters	-
locale	string (Local) [1 .. 10] characters Nullable.	Default locale for this user.
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
inst_admin	boolean (Inst admin)	Whether this user is administrator of the institution.
legal_admin	boolean (Inst admin)	Whether this user can manage legal data of the institution.
send_admin	boolean (Send admin)	Whether this user can manage SEND data of the institution.
data_admin	boolean (Data admin)	Whether this user can manage the data of the institution.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "consent": {
    "version": "string"
  },
  "email": "user@example.com",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true
}

Responses

Response sample

201

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "uid": "string",
  "inst_admin": true,
  "legal_admin": true,
  "send_admin": true,
  "data_admin": true,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

12.9 Delete Institution Learner IC

API endpoint that deletes Institution Learner Informed Consent.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/learner/{id}/ic/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

13. Institution SEND Management

Set of API endpoint that allows Institution SEND Category Data to be viewed or edited.

13.1 GET: List Institution SEND
13.2 POST: Create Institution SEND
13.3 GET: Read Institution SEND
13.4 PUT: Update Institution SEND
13.5 PATCH: Partial Update Institution SEND
13.6 DEL: Delete Institution SEND

[top page]

13.1 List Institution SEND

API endpoint that allows Institution SEND Categories to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/send/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionSENDCategory)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "institution": {
      "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"
    },
    "data": {},
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

13.2 Create Institution SEND

API endpoint that creates Institution SEND Category.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_institution_id}/send/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "data": {},
  "description": "string"
}

Responses

Response sample

201

{
  "id": 0,
  "institution": {
    "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"
  },
  "data": {},
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

13.3 Read Institution SEND

API endpoint that allows access to Institution SEND Category data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_institution_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "data": {},
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

13.4 Update Institution SEND

API endpoint that updates Institution SEND Category data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_institution_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "data": {},
  "description": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "data": {},
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

13.5 Partial Update Institution SEND

API endpoint that updates Institution SEND Category data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_institution_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
data	object (InstitutionSENDCategoryData)	Default: {}
description `required`	string (Description) non-empty	Category description.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "institution": {
    "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
  },
  "data": {},
  "description": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "data": {},
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

13.6 Delete Institution SEND

API endpoint that deletes Institution SEND Category.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_institution_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

14. Institution Learner SEND Management

Set of API endpoint that allows Institution Learner SEND Data to be viewed or edited.

14.1 GET: List Institution Learner SEND
14.2 POST: Create Institution Learner SEND
14.3 GET: Read Institution Learner SEND
14.4 PUT: Update Institution Learner SEND
14.5 PATCH: Partial Update Institution Learner SEND
14.6 DEL: Delete Institution Learner SEND

[top page]

14.1 List Institution Learner SEND

API endpoint that allows Institution Learner SEND to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_learner__institution_id}/learner/{parent_lookup_learner_id}/send/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_learner__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionSENDLearner)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "expires_at": "2019-08-24T14:15:22Z",
    "category": 0,
    "info": {
      "id": 0,
      "institution": {
        "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"
      },
      "data": {},
      "description": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
]
}

[top section] [top page]

14.2 Create Institution Learner SEND

API endpoint that creates Institution Learner SEND.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_learner__institution_id}/learner/{parent_lookup_learner_id}/send/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_learner__institution_id `required`	string	Request path parameter.
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Request sample

{
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "institution": {
      "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
    },
    "data": {},
    "description": "string"
  }
}

Responses

Response sample

201

{
  "id": 0,
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "id": 0,
    "institution": {
      "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"
    },
    "data": {},
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

[top section] [top page]

14.3 Read Institution Learner SEND

API endpoint that allows access to Institution Learner SEND data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_learner__institution_id}/learner/{parent_lookup_learner_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_learner__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Responses

Response sample

200

{
  "id": 0,
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "id": 0,
    "institution": {
      "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"
    },
    "data": {},
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

[top section] [top page]

14.4 Update Institution Learner SEND

API endpoint that updates Institution Learner SEND data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_learner__institution_id}/learner/{parent_lookup_learner_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_learner__institution_id `required`	string	Request path parameter.
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Request sample

{
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "institution": {
      "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
    },
    "data": {},
    "description": "string"
  }
}

Responses

Response sample

200

{
  "id": 0,
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "id": 0,
    "institution": {
      "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"
    },
    "data": {},
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

[top section] [top page]

14.5 Partial Update Institution Learner SEND

API endpoint that updates Institution Learner SEND data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_learner__institution_id}/learner/{parent_lookup_learner_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_learner__institution_id `required`	string	Request path parameter.
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
expires_at	string <date-time> (Expires at) Nullable.	-
category `required`	integer (Category)	Category description.
info	object (InstitutionSENDCategory)	-

Request sample

{
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "institution": {
      "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
    },
    "data": {},
    "description": "string"
  }
}

Responses

Response sample

200

{
  "id": 0,
  "expires_at": "2019-08-24T14:15:22Z",
  "category": 0,
  "info": {
    "id": 0,
    "institution": {
      "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"
    },
    "data": {},
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

[top section] [top page]

14.6 Delete Institution Learner SEND

API endpoint that deletes Institution Learner SEND.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_learner__institution_id}/learner/{parent_lookup_learner_id}/send/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_learner__institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

15. Institution Course Instructor Management

Set of API endpoint that allows Institution Course Instructors to be viewed or edited.

15.1 GET: List Institution Course Instructor
15.2 POST: Create Institution Course Instructor
15.3 GET: Read Institution Course Instructor
15.4 PUT: Update Institution Course Instructor
15.5 PATCH: Partial Update Institution Course Instructor
15.6 DEL: Delete Institution Course Instructor

[top page]

15.1 List Institution Course Instructor

API endpoint that allows Institution Course Instructors to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/instructor/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionInstructor)	-

Responses

Response sample

200

{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    {
      "id": 0,
      "username": "string",
      "uid": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

[top section] [top page]

15.2 Create Institution Course Instructor

API endpoint that creates Institution Course Instructor.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/instructor/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
uid `required`	string (Uid) non-empty	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.

Request sample

{
  "uid": "string"
}

Responses

Response sample

201

{
  "id": 0,
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

15.3 Read Institution Course Instructor

API endpoint that allows access to Institution Course Instructor data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

15.4 Update Institution Course Instructor

API endpoint that updates Institution Course Instructor data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
uid `required`	string (Uid) non-empty	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.

Request sample

{
  "uid": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

15.5 Partial Update Institution Course Instructor

API endpoint that updates Institution Course Instructor data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
uid `required`	string (Uid) non-empty	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.

Request sample

{
  "uid": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

15.6 Delete Institution Course Instructor

API endpoint that deletes Institution Course Instructor.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/instructor/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

16. Institution Course Learner Management

Set of API endpoint that allows Institution Course Learners to be viewed or edited.

16.1 GET: List Institution Course Learner
16.2 POST: Create Institution Course Learner
16.3 GET: Read Institution Course Learner
16.4 PUT: Update Institution Course Learner
16.5 PATCH: Partial Update Institution Course Learner
16.6 DEL: Delete Institution Course Learner

[top page]

16.1 List Institution Course Learner

API endpoint that allows Institution Course Learners to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionLearner)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "institution": {
      "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"
    },
    "username": "string",
    "uid": "string",
    "first_name": "string",
    "last_name": "string",
    "locale": "string",
    "consent": {
      "version": "string",
      "status": "string"
    },
    "consent_accepted": "2019-08-24T14:15:22Z",
    "consent_rejected": "2019-08-24T14:15:22Z",
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "last_login": "2019-08-24T14:15:22Z",
    "send": {},
    "email": "user@example.com",
    "ic_status": "string",
    "login_allowed": false,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "joined_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

16.2 Create Institution Course Learner

API endpoint that creates Institution Course Learner.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
uid `required`	string (Uid) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
locale	string (Local) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "uid": "string",
  "consent": {
    "version": "string"
  }
}

Responses

Response sample

201

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

16.3 Read Institution Course Learner

API endpoint that allows access to Institution Course Learner data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
locale	string (Local) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

16.4 Update Institution Course Learner

API endpoint that updates Institution Course Learner data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
uid `required`	string (Uid) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
locale	string (Local) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "uid": "string",
  "consent": {
    "version": "string"
  }
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

16.5 Partial Update Institution Course Learner

API endpoint that updates Institution Course Learner data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
institution	object (Institution)	-
uid `required`	string (Uid) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
institution	object (Institution)	-
username	string (Username) non-empty	-
uid `required`	string (Uid) non-empty	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
locale	string (Local) non-empty	-
consent	object (InstitutionLearnerConsent) Nullable.	-
consent_accepted	string <date-time> (Consent accepted)	-
consent_rejected	string <date-time> (Consent rejected)	-
learner_id	string <uuid> (Learner id)	-
last_login	string <date-time> (Last login)	-
send	object (Send)	-
email	string <email> (Email) non-empty	-
ic_status	string (IC status) non-empty	-
login_allowed	boolean (Login allowed)	Default: false
created_at	string <date-time> (Created at)	Date when user was created.
updated_at	string <date-time> (Updated at)	Last user modification.
joined_at	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

{
  "institution": {
    "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
  },
  "uid": "string",
  "consent": {
    "version": "string"
  }
}

Responses

Response sample

200

{
  "id": 0,
  "institution": {
    "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"
  },
  "username": "string",
  "uid": "string",
  "first_name": "string",
  "last_name": "string",
  "locale": "string",
  "consent": {
    "version": "string",
    "status": "string"
  },
  "consent_accepted": "2019-08-24T14:15:22Z",
  "consent_rejected": "2019-08-24T14:15:22Z",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "last_login": "2019-08-24T14:15:22Z",
  "send": {},
  "email": "user@example.com",
  "ic_status": "string",
  "login_allowed": false,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

16.6 Delete Institution Course Learner

API endpoint that deletes Institution Course Learner.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_id}/learner/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

17. Institution Course Activity Management

Set of API endpoint that allows Institution Course Activity Data to be viewed or edited.

17.1 GET: List Institution Course Activity
17.2 POST: Create Institution Course Activity
17.3 GET: Read Institution Course Activity
17.4 PUT: Update Institution Course Activity
17.5 PATCH: Partial Update Institution Course Activity
17.6 DEL: Delete Institution Course Activity

[top page]

17.1 List Institution Course Activity

API endpoint that allows Institution Course Activity to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_course_id}/activity/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionCourseActivity)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "name": "string",
    "start": "string",
    "end": "string",
    "description": "string",
    "enabled": true,
    "conf": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

17.2 Create Institution Course Activity

API endpoint that creates Institution Course Activity.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_course_id}/activity/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle_activity_type	string (VLE activity type)	-
vle_activity_id	string (VLE activity ID)	-
name	string (Name)	-
start	string (Start)	-
end	string (End)	-
description	string (Description)	-
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "enabled": true,
  "conf": "string"
}

Responses

Response sample

201

{
  "id": 0,
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "name": "string",
  "start": "string",
  "end": "string",
  "description": "string",
  "enabled": true,
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

17.3 Read Institution Course Activity

API endpoint that allows access to Institution Course Activity data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_course_id}/activity/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle_activity_type	string (VLE activity type)	-
vle_activity_id	string (VLE activity ID)	-
name	string (Name)	-
start	string (Start)	-
end	string (End)	-
description	string (Description)	-
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample

200

{
  "id": 0,
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "name": "string",
  "start": "string",
  "end": "string",
  "description": "string",
  "enabled": true,
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

17.4 Update Institution Course Activity

API endpoint that updates Institution Course Activity data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_course_id}/activity/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle_activity_type	string (VLE activity type)	-
vle_activity_id	string (VLE activity ID)	-
name	string (Name)	-
start	string (Start)	-
end	string (End)	-
description	string (Description)	-
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "enabled": true,
  "conf": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "name": "string",
  "start": "string",
  "end": "string",
  "description": "string",
  "enabled": true,
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

17.5 Partial Update Institution Course Activity

API endpoint that updates Institution Course Activity data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_course_id}/activity/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle_activity_type	string (VLE activity type)	-
vle_activity_id	string (VLE activity ID)	-
name	string (Name)	-
start	string (Start)	-
end	string (End)	-
description	string (Description)	-
enabled	boolean (Enabled)	Whether this activity is enabled or not.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "enabled": true,
  "conf": "string"
}

Responses

Response sample

200

{
  "id": 0,
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "name": "string",
  "start": "string",
  "end": "string",
  "description": "string",
  "enabled": true,
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

17.6 Delete Institution Course Activity

API endpoint that deletes Institution Course Activity.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_vle__institution_id}/course/{parent_lookup_course_id}/activity/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle__institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

18. Institution Course Activity Instrument Management

Set of API endpoint that allows Institution Course Activity Instrument Data to be viewed or edited.

18.1 GET: List Institution Course Activity Instrument
18.2 POST: Create Institution Course Activity Instrument
18.3 GET: Read Institution Course Activity Instrument
18.4 PUT: Update Institution Course Activity Instrument
18.5 PATCH: Partial Update Institution Course Activity Instrument
18.6 DEL: Delete Institution Course Activity Instrument

[top page]

18.1 List Institution Course Activity Instrument

API endpoint that allows Institution Course Activity Instrument to be listed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/instrument/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionCourseActivityInstrument)	-

Responses

Response sample

200

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

[top section] [top page]

18.2 Create Institution Course Activity Instrument

API endpoint that creates Institution Course Activity Instrument.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/instrument/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Request sample

{
  "options": {},
  "instrument": {
    "name": "string",
    "acronym": "string",
    "queue": "string",
    "enabled": true,
    "requires_enrolment": true,
    "description": "string",
    "identity": true,
    "originality": true,
    "authorship": true,
    "integrity": true,
    "options_schema": "string"
  },
  "instrument_id": 0,
  "active": true,
  "alternative_to": 0
}

Responses

Response sample

201

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

[top section] [top page]

18.3 Read Institution Course Activity Instrument

API endpoint that allows access to Institution Course Activity Instrument data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/instrument/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this activity instrument.
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Responses

Response sample

200

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

[top section] [top page]

18.4 Update Institution Course Activity Instrument

API endpoint that updates Institution Course Activity Instrument data.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/instrument/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Request sample

{
  "options": {},
  "instrument": {
    "name": "string",
    "acronym": "string",
    "queue": "string",
    "enabled": true,
    "requires_enrolment": true,
    "description": "string",
    "identity": true,
    "originality": true,
    "authorship": true,
    "integrity": true,
    "options_schema": "string"
  },
  "instrument_id": 0,
  "active": true,
  "alternative_to": 0
}

Responses

Response sample

200

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

[top section] [top page]

18.5 Partial Update Institution Course Activity Instrument

API endpoint that updates Institution Course Activity Instrument data.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/instrument/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
options	object (Options) Nullable.	-
instrument	object (InstitutionCourseActivityInstrumentInfo)	-
instrument_id `required`	integer (Instrument ID)	-
active `required`	boolean (Active)	Is Instrument active?
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-
alternative_to	integer (Alternative to) Nullable.	Primary Instrument to be used.

Request sample

{
  "options": {},
  "instrument": {
    "name": "string",
    "acronym": "string",
    "queue": "string",
    "enabled": true,
    "requires_enrolment": true,
    "description": "string",
    "identity": true,
    "originality": true,
    "authorship": true,
    "integrity": true,
    "options_schema": "string"
  },
  "instrument_id": 0,
  "active": true,
  "alternative_to": 0
}

Responses

Response sample

200

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

[top section] [top page]

18.6 Delete Institution Course Activity Instrument

API endpoint that deletes Institution Course Activity Instrument.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/instrument/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.

Responses

Response sample

204

{
}

[top section] [top page]

19. Institution Course Activity Report Management

Set of API endpoint that allows view Activity Reports from a Course.

19.1 GET: List Institution Course Activity Report
19.2 GET: Read Institution Course Activity Report

[top page]

19.1 List Institution Course Activity Report

API endpoint that lists Activity Reports in a Course.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/report/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionCourseActivityReport)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "learner": {
      "id": 0,
      "uid": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7"
    },
    "detail": [
      {
        "instrument": "string",
        "enrolment": 0,
        "confidence": 0,
        "result": 0,
        "identity_level": 0,
        "content_level": 0,
        "integrity_level": 0,
        "instrument_id": 0
      }
    ],
    "identity_level": 0,
    "content_level": 0,
    "integrity_level": 0
  }
]
}

[top section] [top page]

19.2 Read Institution Course Activity Report

API endpoint that allows view Activity Reports data from a Course.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/report/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this Report Activity.
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner `required`	object (InstitutionCourseActivityReportLearner)	-
detail `required`	Array of objects (InstitutionCourseActivityReportDetail)	-
identity_level	integer (Identity Level) Enum: 0, 1, 2, 3, 4	Alert level for learner identity.
content_level	integer (Content Level) Enum: 0, 1, 2, 3, 4	Alert level for content authorship.
integrity_level	integer (Integrity Level) Enum: 0, 1, 2, 3, 4	Alert level for system integrity.

Responses

Response sample

200

{
  "id": 0,
  "learner": {
    "id": 0,
    "uid": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7"
  },
  "detail": [
    {
      "instrument": "string",
      "enrolment": 0,
      "confidence": 0,
      "result": 0,
      "identity_level": 0,
      "content_level": 0,
      "integrity_level": 0,
      "instrument_id": 0
    }
  ],
  "identity_level": 0,
  "content_level": 0,
  "integrity_level": 0
}

[top section] [top page]

20. Institution Course Activity Report Request Management

Set of API endpoint that allows view Activity Reports Requests in a Course.

20.1 GET: List Institution Course Activity Report Request
20.2 GET: Read Institution Course Activity Report Request

[top page]

20.1 List Institution Course Activity Report Request

API endpoint that lists Activity Reports Requests in a Course.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/report/{parent_lookup_id}/request/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.
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	-
next	string <uri> Nullable.	-
previous	string <uri> Nullable.	-
results `required`	Array of objects (InstitutionCourseActivityReportRequest)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "result": [
      {
        "id": 0,
        "status": 0,
        "result": 0,
        "error_message": "string",
        "code": 0,
        "audit": "http://example.com",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "request": 0,
        "instrument": 0,
        "message_code": "string"
      }
    ],
    "status": 0,
    "data": "http://example.com",
    "error_message": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "learner": "string",
    "activity": 0,
    "session": 0,
    "message_code": "string",
    "instruments": [
      0
    ]
  }
]
}

[top section] [top page]

20.2 Read Institution Course Activity Report Request

API endpoint that allows view Activity Reports Requests data from a Course.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_activity__vle__institution_id}/course/{parent_lookup_activity__course_id}/activity/{parent_lookup_activity_id}/report/{parent_lookup_id}/request/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this Report Activity.
parent_lookup_id `required`	string	Request path parameter.
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_activity__course_id `required`	string	Request path parameter.
parent_lookup_activity__vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
result `required`	Array of objects (InstitutionCourseActivityReportRequestResult)	-
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6	Status for this request.
data	string <uri> (Data)	Data path on storage.
error_message	string (Error message) non-empty Nullable.	Error message when status is error.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-
learner `required`	string (Learner)	-
activity	integer (Activity) Nullable.	-
session	integer (Session) Nullable.	Assessment session for this request
message_code	string (Message code) Nullable.	Related message code.
instruments `required`	Array of integers	-

Responses

Response sample

200

{
  "id": 0,
  "result": [
    {
      "id": 0,
      "status": 0,
      "result": 0,
      "error_message": "string",
      "code": 0,
      "audit": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "request": 0,
      "instrument": 0,
      "message_code": "string"
    }
  ],
  "status": 0,
  "data": "http://example.com",
  "error_message": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "learner": "string",
  "activity": 0,
  "session": 0,
  "message_code": "string",
  "instruments": [
    0
  ]
}

[top section] [top page]

21. Institution Course Activity Report Audit Management

Set of API endpoint that allows view Activity Report Audit data.

21.1 GET: List Institution Course Activity Report Audit
21.2 GET: Read Institution Course Activity Report Audit

[top page]

21.1 List Institution Course Activity Report Audit

API endpoint that lists Activity Report Audit data.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_report__activity__vle__institution_id}/course/{parent_lookup_report__activity__course_id}/activity/{parent_lookup_report__activity_id}/report/{parent_lookup_report_id}/audit/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_report_id `required`	string	Request path parameter.
parent_lookup_report__activity_id `required`	string	Request path parameter.
parent_lookup_report__activity__course_id `required`	string	Request path parameter.
parent_lookup_report__activity__vle__institution_id `required`	string	Request path parameter.
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 (InstitutionCourseActivityReportAudit)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "enrolment": -32768,
    "confidence": -32768,
    "result": -32768,
    "identity_level": 0,
    "content_level": 0,
    "integrity_level": 0,
    "audit_data": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "report": 0,
    "instrument": 0
  }
]
}

[top section] [top page]

21.2 Read Institution Course Activity Report Audit

API endpoint that allows view Activity Reports Audits data from a Course.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/institution/{parent_lookup_report__activity__vle__institution_id}/course/{parent_lookup_report__activity__course_id}/activity/{parent_lookup_report__activity_id}/report/{parent_lookup_report_id}/audit/{instrument_id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
instrument_id `required`	string	Request path parameter.
parent_lookup_report_id `required`	string	Request path parameter.
parent_lookup_report__activity_id `required`	string	Request path parameter.
parent_lookup_report__activity__course_id `required`	string	Request path parameter.
parent_lookup_report__activity__vle__institution_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
enrolment `required`	integer (Enrolment) [ -32768 .. 32767 ]	Enrolment percentage.
confidence `required`	integer (Confidence) [ -32768 .. 32767 ]	Confidence percentage.
result `required`	integer (Result) [ -32768 .. 32767 ]	Result percentage.
identity_level	integer (Identity level) Enum: 0, 1, 2, 3, 4	Alert level for learner identity.
content_level	integer (Content level) Enum: 0, 1, 2, 3, 4	Alert level for content authorship.
integrity_level	integer (Integrity level) Enum: 0, 1, 2, 3, 4	Alert level for system integrity.
audit_data	string <uri> (Audit data) Nullable.	Path to the audit data.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-
report `required`	integer (Report)	Related Activity Report.
instrument `required`	integer (Instrument)	Instrument related to this report detail.

Responses

Response sample

200

{
  "id": 0,
  "enrolment": -32768,
  "confidence": -32768,
  "result": -32768,
  "identity_level": 0,
  "content_level": 0,
  "integrity_level": 0,
  "audit_data": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "report": 0,
  "instrument": 0
}

[top section] [top page]

Institution

Table of Contents

1. Institution Management

1.1 List Institution

Request

Parameters

Responses

Response sample

1.2 Read Institution

Request

Parameters

Responses

Response sample

1.3 Update Institution

Request

Parameters

Request sample

Responses

Response sample

1.4 Partial Update Institution

Request

Parameters

Request sample

Responses

Response sample

2. Institution VLE Management

2.1 List Institution VLE

Request

Parameters

Responses

Response sample

2.2 Create Institution VLE

Request

Parameters

Request sample

Responses

Response sample

2.3 Read Institution VLE

Request

Parameters

Responses

Response sample

2.4 Update Institution VLE

Request

Parameters

Request sample

Responses

Response sample

2.5 Partial Update Institution VLE

Request

Parameters

Request sample

Responses

Response sample

2.6 Delete Institution VLE

Request

Parameters

Responses

Response sample

3. Institution Course Management

3.1 List Institution Course

Request

Parameters

Responses

Response sample

3.2 Read Institution Course

Request

Parameters

Responses

Response sample

4. Institution Group Management

4.1 List Institution Group

Request

Parameters

Responses

Response sample

4.2 Create Institution Group

Request

Parameters

Request sample