Off-The-Job changes in line with the ESFA Funding Rules 2022/23

Click here to see our planned changes to support the new funding rules. Get involved by upvoting, commenting and following the topic to receive updates!

Scheduled Maintenance: Saturday 8th October 2022 - 07:00-07:30am

On Saturday morning, we're carrying out server maintenance. 

Please ensure you have saved any work and have logged out prior to 7:00am to avoid any potential loss of data.

Help centre

Submit a ticket Log in

Assigning users to learners via the API

This series of guides, will provide information on how to build a data integration with a 3rd party system, using the OneFile API:

  1. Initial data download using API
  2. Creating and managing users via the API
  3. Assigning users to learners via the API
  4. Assigning Framework Templates, Standards and Units via the API

To change the Default Assessor, or the Default Employer, call the POST /api/v2.1/User/{id} endpoint.

Other users can be assigned to learners by calling the POST /api/v2.1/User/{id}/Assign endpoint.

The level property is used to specify how the user is to be assigned to the learner.

Assignment LevelUser Role(s)LevelAdditional Body Data Required
Learning AimAssessor
IQA
3StandardID
Unit SummaryAssessor
IQA
2UnitID
AdditionalAssessor
IQA
Employer
Observer
1


Examples of each call can be found below:

Change Default Assessor

POST /api/v2.1/User/{id}

{
    "DefaultAssessorID": {id}
}

Assign/Change Default Employer

POST /api/v2.1/User/{id}

{

    "DefaultEmployerID": {id}
}

Assign/Change Learning Aim Assessor/IV

POST /api/v2.1/User/{id}/Assign

{

    "LearnerID": {id},
    "Level": 3,
    "StandardID: {id}
}

Assign/Change Unit Summary Assessor/IV

POST /api/v2.1/User/{id}/Assign

{ 
    "LearnerID": {id},
    "Level": 2,
    "UnitID: {id}
}

Assign Additional Assessor/IV/Employer/Observer

POST /api/v2.1/User/{id}/Assign

{ 
    "LearnerID": {id}
    "Level": 1
}

Next Guide - Assigning Templates, Standards and Units

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.