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

Set of API endpoints that allows access to VLE related models.

VLE Management
VLE Course Management
VLE Instrument Management
VLE Course Instructor Management
VLE Course Learner Management
VLE Course Activity Management
VLE Course Activity Attachment Management
VLE Course Activity Instrument Management
VLE Course Activity Learner Management
VLE Course Activity Report Management

1. VLE Management

1.1 GET: List VLE
1.2 GET: Read VLE
1.3 POST: VLE Assesment : create a new assessment session.
1.4 POST: VLE Launcher : create a new launcher url for VLE user.

[top page]

1.1 List VLE

API endpoint for listing Providers.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/
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 (VLE)	-

Responses

Response sample

200

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

[top section] [top page]

1.2 Read VLE

Retrieves information about a VLE.

Request

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

Parameters:

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this VLE.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
type `required`	string (Type) non-empty.	-
name `required`	string (Name) [1 .. 250] characters	VLE unique name.
url	string (Url name) Nullable	VLE url.
client_id	string (Client_id) [1 .. 250] characters Nullable	LTI 1.3 Client ID.

Responses

Response sample: 200

200

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

[top section] [top page]

1.3 VLE Assessment

API endpoint that creates a new assessment session.

Request

Concept	Data
HTTP method	`POST`
Path	/api/v2/vle/{id}/assessment/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this VLE.
data	object (VLENewAssessmentSessionData)	-
checked_at	string <date-time> (Checked at) Nullable.	Last time this assessment session has been checked.
closed_at	string <date-time> (Closed at) Nullable.	Date the assessment session has been closed.
auto_closed	boolean (Auto closed) Nullable.	Whether this session has been automatically closed.
activity `required`	integer (Activity)	Activity of this session.
learner `required`	string (Learner)	Learner of this session.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
data	object (VLENewAssessmentSessionData)	-
started_at	string <date-time> (Started at) Nullable.	Date when this assessment session started.
checked_at	string <date-time> (Checked at) Nullable.	Last time this assessment session has been checked.
closed_at	string <date-time> (Closed at) Nullable.	Date the assessment session has been closed.
auto_closed	boolean (Auto closed) Nullable.	Whether this session has been automatically closed.
activity `required`	integer (Activity)	Activity of this session.
learner `required`	string (Learner)	Learner of this session.

Request Sample:

{
  "data": {
    "session": 0
  },
  "checked_at": "2019-08-24T14:15:22Z",
  "closed_at": "2019-08-24T14:15:22Z",
  "auto_closed": true,
  "activity": 0,
  "learner": "string"
}

Responses

Response sample: 201

201

{
  "id": 0,
  "data": {
    "id": 0,
    "connector": "http://example.com",
    "data": "http://example.com",
    "session": 0
  },
  "started_at": "2019-08-24T14:15:22Z",
  "checked_at": "2019-08-24T14:15:22Z",
  "closed_at": "2019-08-24T14:15:22Z",
  "auto_closed": true,
  "activity": 0,
  "learner": "string"
}

[top section] [top page]

1.4 VLE Launcher

API endpoint that creates a new launcher url for VLE user.

Request

Concept	Data
HTTP method	`POST`
Path	/api/v2/vle/{vle_user_uid}/launcher/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
vle_user_uid `required`	string	Identifier of the user in the vle.
vle_id	int	Identifier of the vle. If not provided take it from module configuration.
target	string	The target for the launcher. Accepted values are "dashboard" (default) and "lapi". Default: 'DASHBOARD'
target_url	string	The url where launcher is expected to be redirected.
ttl	int	The amount of time this launcher will be valid. Default: 120
session_id	int	The assessment session linked to this launcher.

Response parameters.

Name	Type	Comments
-	dict	Launcher id and token.

Request Sample:

{
	"vle_user_uid": "learner1@example.com",
    "target": "DASHBOARD",
    "ttl": 120,
    "session_id": null,
    "target_url": null
}

Responses

Response sample: 200

200

{
  "token": "df249481-1ad6-4c2e-ba8e-2db10132b5f4",
  "id": 123,
  "url": "https://yourdomain.com/ui/auth/launcher?id=123&token=df249481-1ad6-4c2e-ba8e-2db10132b5f4"
}

[top section] [top page]

2. VLE Course Management

Set of API endpoints that allow a course in a VLE to be viewed or edited.

2.1 GET: List VLE Courses
2.2 POST: Create VLE Course
2.3 GET: Read VLE Course
2.4 PUT: Update VLE Course
2.5 PATCH: Partial Update VLE Course
2.6 DELETE: Delete VLE Course

[top page]

2.1 List VLE Courses

API endpoint for listing Courses in a VLE.

Request

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

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_vle_id `required`	string	Request path parameter.
search	string	A search term
code	string	-
vle_course_id	string	-
description	string	-
vle	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 (VLECourse)	-

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"
    },
    "code": "string",
    "vle_course_id": "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]

2.2 Create VLE Course

API endpoint for creating a new Course in a VLE.

Request

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

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_vle_id `required`	string	Request path parameter.
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request Sample:

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

Responses

Response sample

201

{
"id": 0,
"vle": {
  "id": 0,
  "type": "string",
  "name": "string",
  "url": "string",
  "client_id": "string"
},
"code": "string",
"vle_course_id": "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]

2.3 Read VLE Course

Retrieves information about a Course in a VLE.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

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

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "vle": {
    "id": 0,
    "type": "string",
    "name": "string",
    "url": "string",
    "client_id": "string"
  },
  "code": "string",
  "vle_course_id": "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]

2.4 Update VLE Course

API endpoint that updates a Course in a VLE.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

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

Responses

Response sample: 200

200

{
  "id": 0,
  "vle": {
    "id": 0,
    "type": "string",
    "name": "string",
    "url": "string",
    "client_id": "string"
  },
  "code": "string",
  "vle_course_id": "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]

2.5 Partial Update VLE Course

API endpoint that updates a Course in a VLE.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
vle	object (VLE)	-
code `required`	string (Code) [1 .. 250] characters	Course code.
vle_course_id `required`	string (VLE Course ID) [1 .. 250] characters	Course ID on the VLE.
description	string (Description) Nullable.	Course description.
start	string <date-time> (Start) Nullable.	When course starts.
end	string <date-time> Nullable.	When course ends.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

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

Responses

Response sample: 200

200

{
  "id": 0,
  "vle": {
    "id": 0,
    "type": "string",
    "name": "string",
    "url": "string",
    "client_id": "string"
  },
  "code": "string",
  "vle_course_id": "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]

2.6 Delete VLE Course

API endpoint for deleting a Course in a VLE.

Request

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

Parameters:

Request parameters.

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

Responses

Response sample: 204

204

{
}

[top section] [top page]

3. VLE Instrument Management

Set of API endpoints that allows access to VLE related models.

3.1 GET: List VLE Instrument
3.2 GET: Read VLE Instrument

[top page]

3.1 List VLE Instrument

API endpoint for listing VLE Instruments.

Request

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

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_vle_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 (VLEInstrument)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "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"
  }
]
}

[top section] [top page]

3.2 Read VLE Instrument

Retrieves information about VLE Instrument.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/instrument/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this Instrument.
parent_lookup_vle_id `required`	string	Request path parameter.

Response parameters.

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

Responses

Response sample: 200

200

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

[top section] [top page]

4. VLE Course Instructor Management

Set of API endpoints that allows Instructor in a Course to be viewed or edited.

4.1 GET: List VLE Course Instructor
4.2 POST: Create VLE Course Instructor
4.3 GET: Read VLE Course Instructor
4.4 PUT: Update VLE Course Instructor
4.5 PATCH: Partial Update VLE Course Instructor
4.6 DELETE: Delete VLE Course Instructor

[top page]

4.1 List VLE Course Instructor

API endpoint for listing Instructors from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/instructor/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
search	string	A search term
uid	string	-
email	string	-
first_name	string	-
last_name	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 (VLECourseActivity)	-

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]

4.2 Create VLE Course Instructor

API endpoint for creating Instructor for a Course in a VLE.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/instructor/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_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 (Locale) [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 (Locale) [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]

4.3 Read VLE Course Instructor

API endpoint for reading Instructor from a Course in a VLE.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/instructor/{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_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 (Locale) [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

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]

4.4 Update VLE Course Instructor

API endpoint that updates an Instructor from a Course in a VLE.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/instructor/{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_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 (Locale) [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 (Locale) [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

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]

4.5 Partial Update VLE Course Instructor

API endpoint that updates an Instructor from a Course in a VLE.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/instructor/{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_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 (Locale) [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 (Locale) [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

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]

4.6 Delete VLE Course Instructor

API endpoint for deleting an Instructor from a Course in a VLE.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/instructor/{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.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

5. VLE Course Learner Management

Set of API endpoints that allows learners in a course to be viewed or edited.

5.1 GET: List VLE Course Learner
5.2 POST: Create VLE Course Learner
5.3 GET: Read VLE Course Learner
5.4 PUT: Update VLE Course Learner
5.5 PATCH: Partial Update VLE Course Learner
5.6 DELETE: Delete VLE Course Learner

[top page]

5.1 List VLE Course Learner

API endpoint for listing Learner from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
search	string	A search term
uid	string	-
email	string	-
first_name	string	-
last_name	string	-
learner_id	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 (VLECourseLearner)	-

Responses

Response sample

200

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

[top section] [top page]

5.2 Create VLE Course Learner

API endpoint for creating Learner for a Course in a VLE.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
consent	object (VLECourseLearnerConsent) Nullable.	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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	-
consent	object (VLECourseLearnerConsent) 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)	-
ic_status	string (IC Status) non-empty	-
enrolment_status	object (Enrolment status)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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_	string <date-time> (Joined at)	Date the learner joined for this institution.

Request Sample:

{
  "consent": {
    "version": "string"
  },
  "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",
"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": {},
"ic_status": "string",
"enrolment_status": {},
"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,
"joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.3 Read VLE Course Learner

API endpoint for reading Learner from a Course in a VLE.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/learner/{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_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
username	string (Username) non-empty	-
consent	object (VLECourseLearnerConsent) 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)	-
ic_status	string (IC Status) non-empty	-
enrolment_status	object (Enrolment status)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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_	string <date-time> (Joined at)	Date the learner joined for this institution.

Responses

Response sample: 200

200

{
  "id": 0,
  "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": {},
  "ic_status": "string",
  "enrolment_status": {},
  "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,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.4 Update VLE Course Learner

API endpoint that updates a Learner from a Course in a VLE.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/learner/{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_id `required`	string	Request path parameter.
consent	object (VLECourseLearnerConsent) Nullable.	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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	-
consent	object (VLECourseLearnerConsent) 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)	-
ic_status	string (IC Status) non-empty	-
enrolment_status	object (Enrolment status)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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_	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

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

200

{
  "id": 0,
  "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": {},
  "ic_status": "string",
  "enrolment_status": {},
  "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,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.5 Partial Update VLE Course Learner

API endpoint that updates a Learner from a Course in a VLE.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/learner/{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_id `required`	string	Request path parameter.
consent	object (VLECourseLearnerConsent) Nullable.	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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	-
consent	object (VLECourseLearnerConsent) 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)	-
ic_status	string (IC Status) non-empty	-
enrolment_status	object (Enrolment status)	-
first_name	string (First name) non-empty	-
last_name	string (Last name) non-empty	-
email	string <email> (Email) non-empty	-
locale	string (Locale) [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_	string <date-time> (Joined at)	Date the learner joined for this institution.

Request sample

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

200

{
  "id": 0,
  "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": {},
  "ic_status": "string",
  "enrolment_status": {},
  "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,
  "joined_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.6 Delete VLE Course Learner

API endpoint for deleting a Learner from a Course in a VLE.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/learner/{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_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

6. VLE Course Activity Management

Set of API endpoints that allows Activity in a Course to be viewed or edited.

6.1 GET: List VLE Course Activity
6.2 POST: Create VLE Course Activity
6.3 GET: Read VLE Course Activity
6.4 PUT: Update VLE Course Activity
6.5 PATCH: Partial Update VLE Course Activity
6.6 DELETE: Delete VLE Course Activity

[top page]

6.1 List VLE Course Activity

API endpoint for listing Activities from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_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_id `required`	string	Request path parameter.
search	string	A search term
vle_id	string	-
vle_activity_type	string	-
vle_activity_id	string	-
course_id	string	-
name	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 (VLECourseActivity)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "course": {
      "id": 0,
      "vle": {
        "id": 0,
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "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"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

6.2 Create VLE Course Activity

API endpoint for creating Activity for a Course in a VLE.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/vle/{parent_lookup_vle_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_id `required`	string	Request path parameter.
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request Sample:

{
  "course": {
    "vle": {
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "string",
    "description": "string",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string"
}

Responses

Response sample

201

{
"id": 0,
"course": {
  "id": 0,
  "vle": {
    "id": 0,
    "type": "string",
    "name": "string",
    "url": "string",
    "client_id": "string"
  },
  "code": "string",
  "vle_course_id": "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"
},
"vle_activity_type": "string",
"vle_activity_id": "string",
"description": "string",
"name": "string",
"enabled": true,
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"conf": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.3 Read VLE Course Activity

API endpoint for reading Activity from a Course in a VLE.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_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.A unique integer value identifying this activity.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "course": {
    "id": 0,
    "vle": {
      "id": 0,
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "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"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.4 Update VLE Course Activity

API endpoint that updates an Activity from a Course in a VLE.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/vle/{parent_lookup_vle_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. A unique integer value identifying this activity.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "course": {
    "vle": {
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "string",
    "description": "string",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string"
}

Responses

Response sample: 200

200

{
  "id": 0,
  "course": {
    "id": 0,
    "vle": {
      "id": 0,
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "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"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.5 Partial Update VLE Course Activity

API endpoint that updates an Activity from a Course in a VLE.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/vle/{parent_lookup_vle_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. A unique integer value identifying this activity.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
course	object (VLECourse)	-
vle_activity_type `required`	string (VLE Activity Type) [1 .. 250] characters	Activity type on the VLE.
vle_activity_id `required`	string (VLE Activity ID) [1 .. 250] characters	Activity ID on the VLE.
description	string (Description) Nullable.	Activity description.
name	string (Name) <= 255 characters. Nullable.	Activity name.
enabled	boolean (Enabled)	Whether this activity is enabled or not.
start	string <date-time> (Start) Nullable.	When Activity starts.
end	string <date-time> Nullable.	When Activity ends.
conf	string (Conf) Nullable.	Activity conf.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "course": {
    "vle": {
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "string",
    "description": "string",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string"
}

Responses

Response sample: 200

200

{
  "id": 0,
  "course": {
    "id": 0,
    "vle": {
      "id": 0,
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "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"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

6.6 Delete VLE Course Activity

API endpoint for deleting an Activity from a Course in a VLE.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/vle/{parent_lookup_vle_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. A unique integer value identifying this activity.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

7. VLE Course Activity Attachment Management

Set of API endpoints that Return the list of instruments (if any) waiting to process the attachment of the activity.

7.1 GET: List VLE Course Activity Attachment
7.2 POST: Create VLE Course Activity Attachment

[top page]

7.1 List VLE Course Activity Attachment

API endpoint for listing Activities from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/activity/{id}/attachment/{learner_id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this activity.
learner_id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
learner_id	string <uuid> (Learner ID) Nullable	-
course_id	integer (Course ID) Nullable	-
activity_id	integer (Activity ID) Nullable	-
session_id	integer (Session ID) Nullable	-
data `required`	string (Data) non-empty.	-
instruments `required`	Array of integers	-
metadata `required`	object (VerificationMetadata)	-
close_session	boolean (Close session) Nullable	Default: true
close_at	string <date-time> (Close at)	-

Responses

Response sample

200

{
"learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
"course_id": 0,
"activity_id": 0,
"session_id": 0,
"data": "string",
"instruments": [
  0
],
"metadata": {
  "filename": "string",
  "mimetype": "string",
  "context": {}
},
"close_session": true,
"close_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

7.2 Create VLE Course Activity Attachment

API endpoint for creating Activity for a Course in a VLE.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/activity/{id}/attachment/{learner_id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this activity.
learner_id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
learner_id	string <uuid> (Learner ID) Nullable	-
course_id	integer (Course ID) Nullable	-
activity_id	integer (Activity ID) Nullable	-
session_id	integer (Session ID) Nullable	-
data `required`	string (Data) non-empty.	-
instruments `required`	Array of integers	-
metadata `required`	object (VerificationMetadata)	-
close_session	boolean (Close session) Nullable	Default: true
close_at	string <date-time> (Close at)	-

Response parameters.

Name	Type	Comments
learner_id	string <uuid> (Learner ID) Nullable	-
course_id	integer (Course ID) Nullable	-
activity_id	integer (Activity ID) Nullable	-
session_id	integer (Session ID) Nullable	-
data `required`	string (Data) non-empty.	-
instruments `required`	Array of integers	-
metadata `required`	object (VerificationMetadata)	-
close_session	boolean (Close session) Nullable	Default: true
close_at	string <date-time> (Close at)	-

Request Sample:

{
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "course_id": 0,
  "activity_id": 0,
  "session_id": 0,
  "data": "string",
  "instruments": [
    0
  ],
  "metadata": {
    "filename": "string",
    "mimetype": "string",
    "context": {}
  },
  "close_session": true,
  "close_at": "2019-08-24T14:15:22Z"
}

Responses

Response sample

201

{
"learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
"course_id": 0,
"activity_id": 0,
"session_id": 0,
"data": "string",
"instruments": [
  0
],
"metadata": {
  "filename": "string",
  "mimetype": "string",
  "context": {}
},
"close_session": true,
"close_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

8. VLE Course Activity Instrument Management

Set of API endpoints that allows Activity instruments in a Course to be viewed or edited.

8.1 GET: List VLE Course Activity Instrument
8.2 POST: Create VLE Course Activity Instrument
8.3 GET: Read VLE Course Activity Instrument
8.4 PUT: Update VLE Course Activity Instrument
8.5 PATCH: Partial Update VLE Course Activity Instrument
8.6 DELETE: Delete VLE Course Activity Instrument

[top page]

8.1 List VLE Course Activity Instrument

API endpoint for listing Activity’s instruments from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_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_course_id `required`	string	Request path parameter.
parent_lookup_vle_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 (VLECourseActivityInstrument)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "activity": {
      "id": 0,
      "course": {
        "id": 0,
        "vle": {
          "id": 0,
          "type": "string",
          "name": "string",
          "url": "string",
          "client_id": "string"
        },
        "code": "string",
        "vle_course_id": "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"
      },
      "vle_activity_type": "string",
      "vle_activity_id": "string",
      "description": "string",
      "name": "string",
      "enabled": true,
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "conf": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "options": {},
    "active": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "instrument": 0,
    "alternative_to": 0
  }
]
}

[top section] [top page]

8.2 Create VLE Course Activity Instrument

API endpoint for adding instrument to Activity for a Course in a VLE.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_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_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
activity	object (VLECourseActivity)	-
options `required`	object (Options) Nullable.	Activity type on the VLE.
active `required`	boolean (Active)	Is instrument active?
instrument `required`	integer (Instrument)	Activity.
alternative_to	integer (Alternative to) Nullable.	Primary instrument to be used.

Response parameters.

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

Request Sample:

{
  "activity": {
    "course": {
      "vle": {
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "string",
      "description": "string",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string"
  },
  "options": {},
  "active": true,
  "instrument": 0,
  "alternative_to": 0
}

Responses

Response sample

201

{
"id": 0,
"activity": {
  "id": 0,
  "course": {
    "id": 0,
    "vle": {
      "id": 0,
      "type": "string",
      "name": "string",
      "url": "string",
      "client_id": "string"
    },
    "code": "string",
    "vle_course_id": "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"
  },
  "vle_activity_type": "string",
  "vle_activity_id": "string",
  "description": "string",
  "name": "string",
  "enabled": true,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "conf": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
},
"options": {},
"active": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"instrument": 0,
"alternative_to": 0
}

[top section] [top page]

8.3 Read VLE Course Activity Instrument

API endpoint for reading Activity’s instrument from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_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_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Response parameters.

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

Responses

Response sample: 200

200

{
  "id": 0,
  "activity": {
    "id": 0,
    "course": {
      "id": 0,
      "vle": {
        "id": 0,
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "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"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "options": {},
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "instrument": 0,
  "alternative_to": 0
}

[top section] [top page]

8.4 Update VLE Course Activity Instrument

API endpoint that updates an Activity’s Instrument from a Course in a VLE.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_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_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
activity	object (VLECourseActivity)	-
options `required`	object (Options) Nullable.	-
active `required`	boolean (Active)	Is instrument active?
instrument `required`	integer (Instrument)	Activity.
alternative_to	integer (Alternative to) Nullable.	Primary instrument to be used.

Response parameters.

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

Request sample

{
  "activity": {
    "course": {
      "vle": {
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "string",
      "description": "string",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string"
  },
  "options": {},
  "active": true,
  "instrument": 0,
  "alternative_to": 0
}

Responses

Response sample: 200

200

{
  "id": 0,
  "activity": {
    "id": 0,
    "course": {
      "id": 0,
      "vle": {
        "id": 0,
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "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"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "options": {},
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "instrument": 0,
  "alternative_to": 0
}

[top section] [top page]

8.5 Partial Update VLE Course Activity Instrument

API endpoint that updates an Activity’s Instrument from a Course in a VLE.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_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_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
activity	object (VLECourseActivity)	-
options `required`	object (Options) Nullable.	-
active `required`	boolean (Active)	Is instrument active?
instrument `required`	integer (Instrument)	Activity.
alternative_to	integer (Alternative to) Nullable.	Primary instrument to be used.

Response parameters.

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

Request sample

{
  "activity": {
    "course": {
      "vle": {
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "string",
      "description": "string",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string"
  },
  "options": {},
  "active": true,
  "instrument": 0,
  "alternative_to": 0
}

Responses

Response sample: 200

200

{
  "id": 0,
  "activity": {
    "id": 0,
    "course": {
      "id": 0,
      "vle": {
        "id": 0,
        "type": "string",
        "name": "string",
        "url": "string",
        "client_id": "string"
      },
      "code": "string",
      "vle_course_id": "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"
    },
    "vle_activity_type": "string",
    "vle_activity_id": "string",
    "description": "string",
    "name": "string",
    "enabled": true,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "conf": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "options": {},
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "instrument": 0,
  "alternative_to": 0
}

[top section] [top page]

8.6 Delete VLE Course Activity Instrument

API endpoint for deleting an Instrument from Activity.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_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_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

9. VLE Course Activity Learner Management

Set of API endpoints that allows access results for learners in an Activity.

9.1 GET: List VLE Course Activity Learner
9.2 GET: Read VLE Course Activity Learner
9.3 GET: List VLE Course Activity Learner Request
9.4 GET: Read VLE Course Activity Learner Request

[top page]

9.1 List VLE Course Activity Learner

Set of API endpoints that allows access results for learners in an Activity.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/activity/{parent_lookup_activity_id}/learner/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
search	string	A search term
uid	string	-
email	string	-
first_name	string	-
last_name	string	-
learner_id	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 (VLECourseActivityLearner)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "uid": "string",
    "institution_id": "string",
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7"
  }
]
}

[top section] [top page]

9.2 Read VLE Course Activity Learner

API endpoint for reading Activity’s instrument from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/activity/{parent_lookup_activity_id}/learner/{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_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
first_name	string (First name) <= 150 characters	-
last_name	string (Last name) <= 150 characters	-
email	string <email> (Email address) <= 254 characters	-
uid `required`	string (Uid) [1 .. 255] characters	Unique User Identifier for the institution.
institution_id	string (Institution ID)	-
learner_id	string <uuid> (Learner id)	Learner unique ID used to anonymize identity with external providers.

Responses

Response sample: 200

200

{
  "id": 0,
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "uid": "string",
  "institution_id": "string",
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7"
}

[top section] [top page]

9.3 List VLE Course Activity Learner Request

API endpoint for listing Activity Learner Requests.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/activity/{parent_lookup_activity_id}/learner/{parent_lookup_learner_id}/request/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_learner_id `required`	string	Request path parameter.
parent_lookup_activity_id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.
search	string	A search term
instruments	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 (VLECourseActivityLearnerRequest)	-

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]

9.4 Read VLE Course Activity Learner Request

API endpoint that allows Activity Learner Request to be viewed.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_vle_id}/course/{parent_lookup_course_id}/activity/{parent_lookup_activity_id}/learner/{parent_lookup_learner_id}/request/{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_activity_id `required`	string	Request path parameter.
parent_lookup_course_id `required`	string	Request path parameter.
parent_lookup_vle_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
result `required`	Array of objects (VLECourseActivityLearnerRequestResult)	-
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)	Unique User Identifier for the institution.
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

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]

10. VLE Course Activity Report Management

10.1 List VLE Course Activity Report
10.2 Read VLE Course Activity Report

[top page]

10.1 List VLE Course Activity Report

API endpoint for listing Activity Reports from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_activity__vle_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_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 (VLECourseActivityReport)	-

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]

10.2 Read VLE Course Activity Report

Retrieves Activity Report from a Course in a VLE.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/vle/{parent_lookup_activity__vle_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_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner `required`	object (VLECourseActivityReportLearner)	-
detail `required`	Array of Objects (VLECourseActivityReportDetail)	-
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

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]

VLE

Table of Contents

1. VLE Management

1.1 List VLE

Request

Parameters

Responses

Response sample

1.2 Read VLE

Request

Parameters:

Responses

Response sample: 200

1.3 VLE Assessment

Request

Parameters:

Request Sample:

Responses

Response sample: 201

1.4 VLE Launcher

Request

Parameters:

Request Sample:

Responses

Response sample: 200

2. VLE Course Management

2.1 List VLE Courses

Request

Parameters

Responses

Response sample

2.2 Create VLE Course

Request

Parameters

Request Sample:

Responses

Response sample

2.3 Read VLE Course

Request

Parameters:

Responses

Response sample: 200

2.4 Update VLE Course

Request

Parameters:

Request sample

Responses

Response sample: 200

2.5 Partial Update VLE Course

Request

Parameters:

Request sample

Responses

Response sample: 200

2.6 Delete VLE Course

Request

Parameters:

Responses

Response sample: 204

3. VLE Instrument Management

3.1 List VLE Instrument

Request

Parameters

Responses

Response sample

3.2 Read VLE Instrument

Request

Parameters:

Responses

Response sample: 200

4. VLE Course Instructor Management

4.1 List VLE Course Instructor

Request

Parameters

Responses

Response sample

4.2 Create VLE Course Instructor

Request

Parameters

Request Sample: