Software Update: Wednesday 26th January 2022 - 07:00-07:30

On Wednesday morning, we're updating OneFile to release some new changes and improvements.

To find out more, our release notes are available 
here.

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

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
}


Did you find it helpful? Yes No

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