Assigning users to learners via the API

Overview

This guide forms part of a series designed to support building a data integration with a third‑party system using the Onefile API. It explains how to assign users such as Assessors, IQAs, Employers, and Observers to learners through API endpoints.

This guide is part of the following API series:

• Initial data download using API
• Creating and managing users via the API
• Assigning users to learners via the API
• Assigning Framework Templates, Standards and Units via the API

User Roles

This API functionality is typically used by:

• Technical Administrators
• Integration Developers
• System Administrators

How to Assign Users to Learners via the API

Different API endpoints are used depending on the type of assignment being made.

Change the Default Assessor or Default Employer

Use the following endpoint:

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

The above {id} is the learner userID.

Assign or change the Default Assessor:

{
  "DefaultAssessorID": {id}
}
  

Assign or change the Default Employer:

{
  "DefaultEmployerID": {id}
}
  

Assign Additional Users to a Learner

To assign other user types (Assessors, IQAs, Employers, Observers), use the Assign endpoint:

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

The above {id} is the learner userID. 

The Level parameter determines the type of assignment being made:

Assignment Levels

Examples

Assign or Change Learning Aim Assessor / IQA

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

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

Assign or Change Unit Summary Assessor / IQA

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

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

Assign Additional Assessor / IQA / Employer / Observer

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

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

Next Guide

Assigning Framework Templates, Standards and Units via the API

Terminology

The terminology used in this article may differ depending on your Centre’s configuration.

Related Articles

• Initial Data Download Using the API
• Creating and Managing Users via the API
• Assigning Templates, Standards and Units via the API

Need Help?

If you need assistance, please contact Onefile Support or your internal support team.