Contents
Definitions
Entities
| Entity | Description |
|---|---|
| Learner | A user of the FutureLearn platform |
| Degree | A degree level qualification offered through FutureLearn (e.g. Graduate Certificate or Masters). Made up of programs |
| Degree Enrolment | A learner’s enrolment on a degree in FutureLearn |
| Organisational membership | A learner’s membership of an organisation |
| Student | A learner that has an active organisation membership record linking them to the university |
Identifiers
| Learning | Learners |
|---|---|
| Delivered | are presented with information |
| Reflective | reflect on activities |
| Collaborative | construct shared understanding |
| Conversational | converse with others |
| Networked | interact with networks of peers |
| Browsing | seek and collate information |
In general, the API uses UUID to identify entities. However supporting ‘find’ methods are provided to allow consumers to resolve these UUIDs from university assigned identifiers if necessary.
Authentication
All API methods are authenticated with a JWT bearer token. Please refer to the Partners API Authentication document attached at the bottom of this document for further information.
Degree enrolment methods
Deactivate degree enrolment method
This method can be used to deactivate an existing degree enrolment.
If the degree enrolment UUID is unknown, it can be looked up using the find degree enrolment method.
HTTP request
| Method | Path |
|---|---|
| POST | partners/degree_enrolments/{degree-enrolment-uuid}/deactivate |
Request body parameters
| Name | Description | Example |
|---|---|---|
| Reason |
The reason why the degree enrolment is being deactivated. Free text, no longer than 250 characters. |
Unconfirmed on census date |
Example
|
Request POST https://api.futurelearn.com/partners/degree_enrolments/85db915f-a944-4e41-8357-76f4862b3b77/deactivate { |
|
Response HTTP/1.1 303 See Other |
Authorisation
Only degree enrolments where the degree belongs to the university and the learner has an organisation membership record linking them to the university can be deactivated using this method.
Reactivate degree enrolment method
This method can be used to reactivate an existing degree enrolment.
If the degree enrolment UUID is unknown, it can be looked up using the find degree enrolment method.
HTTP request
| Method | Path |
|---|---|
| POST | partners/degree_enrolments/{degree-enrolment-uuid}/reactivate |
Request body parameters
| Name | Description | Example |
|---|---|---|
| Reason |
The reason why the degree enrolment is being reactivated. Free text, no longer than 250 characters. |
Late payment received |
Example
|
Request https://api.futurelearn.com/partners/degree_enrolments/85db915f-a944-4e41-8357-76f4862b3b77/reactivate |
|
Response HTTP/1.1 303 See Other |
Authorisation
Only degree enrolments where the degree belongs to the university and the learner has an organisation membership record linking them to the university can be reactivated using this method.
Supporting methods
The university’s student record system might not necessarily store FutureLearn degree enrolment UUIDs. We therefore provide the following API methods that can be used to resolve a degree enrolment UUID from the degree code, and external learner ID (university student ID) instead.
Find degree enrolment method
This method can be used to get a degree enrolment UUID from an organisation membership UUID and degree UUID.
If the degree UUID is unknown it can be looked up using the find degree method. If the organisation membership UUID is unknown it can be looked up using the find organisation membership method.
HTTP request
| Method | Path |
|---|---|
| GET | partners/degree_enrolments/find?degree_uuid={degree-uuid}&organisation_membership_uuid={organisation-membership-uuid} |
Example
|
Request |
|
Response HTTP/1.1 302 Found
|
Authorisation
Only degree enrolments where the degree belongs to the university and the learner has an organisation membership record linking them to the university can be found using this method.
Find degree method
This method can be used to get a degree UUID from a degree code.
HTTP request
| Method | Path |
|---|---|
| GET | partners/degrees/find?degree_code={degree-code} |
Example
|
Request Authorization: Bearer {JWT-token} |
|---|
|
Response HTTP/1.1 302 Found { } |
Authorisation
Only degrees that belong to the university can be found using this method.
Find organisation membership method
This method can be used to get an organisation membership UUID from an external learner ID (university student ID).
HTTP request
| Method | Path |
|---|---|
| GET | partners/organisation_memberships/find?external_learner_id={external-learner-id} |
Example
|
Request |
|---|
|
Response HTTP/1.1 302 Found { } |
Authorisation
Only organisation memberships linked to the university can be found using this method.
Document control
| Rev | Date | Author | Changes |
|---|---|---|---|
| 0.1 | 18/12/2017 | VG | Initial proposal |
Comments
0 comments
Please sign in to leave a comment.