Assigning Framework Templates, Standards and Units via the API

Overview

This guide is part of a series designed to help you build a data integration with a third‑party system using the Onefile API. Once you have downloaded your initial dataset and created or updated users, you can assign Framework Templates, Standards and Units to learners using the API.

This guide covers:

• How to search for Framework Templates, Standards and Units
• How to assign Framework Templates to learners
• How to assign Standards and Units individually
• How to retrieve Learning Aims and Unit Summaries after assignment

Related Guides in This 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

Why Use Framework Templates?

Framework Templates are created by Centre Managers and contain pre‑selected Standards, Units, weightings and optional default dates. Assigning a Framework Template automatically creates the learner’s learning aims and unit summaries in a single operation.

If you assign Standards and Units individually, you must assign each component manually.

Searching for Framework Templates, Standards and Units

Use the following endpoints to retrieve the IDs you will need:

Assigning a Framework Template to a Learner

Assigning a Framework Template will:

• Generate all Learning Aims
• Create Unit Summaries
• Populate any default values set in the Framework Template (start date, end date, weightings)

Endpoint:

POST /api/v2.1/FrameworkTemplate/{id}/Assign/{userId}/{onlyChangeAssigned}

After assigning, you can retrieve the generated Learning Aims and Unit Summaries:

Learning Aims:

POST /api/v2.1/LearningAim/Search/{pageNumber}/{pageSize}

{
  "UserID": {id}
}

Unit Summaries:

POST /api/v2.1/UnitSummary/Search/{pageNumber}/{pageSize}

{
  "UserID": {id}
}

Assigning a Standard to a Learner

Endpoint:

POST /api/v2.1/Standard/{id}/Assign/{learnerID}

Assigning a Standard generates a Learning Aim. The LearningAimID will be returned in the response.

You can then retrieve all learning aims for the learner:

POST /api/v2.1/LearningAim/Search/{pageNumber}/{pageSize}

{
  "UserID": {id}
}

Assigning a Unit to a Learner

Endpoint:

POST /api/v2.1/Unit/{id}/Assign/{learnerID}/{standardID}

Assigning a Unit generates a Unit Summary. The UnitSummaryID will be returned in the response.

You can then retrieve all unit summaries for the learner:

POST /api/v2.1/UnitSummary/Search/{pageNumber}/{pageSize}

{
  "UserID": {id}
}

Tips & Notes

• Framework Templates are the fastest way to assign complete programme structures.
• Use paged search endpoints for larger datasets.
• Always store FrameworkTemplateID, StandardID and UnitID values for ease of automation.
• Assigning Standards or Units individually is useful for non‑standard learning plans.

Terminology

Terminology in this article may differ depending on your Centre or API configuration.

Related Articles

• API Rate Limits

Need Help?

If you need help with API integration or development, please contact Onefile Support or your internal technical team.