Initial data download using 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 authenticated, you may want to download existing data from OneFile to compare, sync, or map against your external system.

This guide covers:

• Retrieving the Customer record
• Finding Organisations linked to the Customer
• Downloading Assessors, Classes, Placements and Learners
• Understanding when multiple Organisations exist
• Using paged searches for detailed fields

Next guides in this series:

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

Base URLs

• Beta Server: https://wsapibeta.onefile.co.uk/api/v2.1
• Practice Server: https://wsapi2.onefile.co.uk/api/v2.1
• Live Server: https://wsapi.onefile.co.uk/api/v2.1

Steps

1. Get CustomerID

GET https://wsapibeta.onefile.co.uk/api/v2.1/Customer

Response:

{
  "ID": 2070,
  "Name": "Example Beta Customer"
}

2. Get Organisations linked to the Customer

POST https://wsapibeta.onefile.co.uk/api/v2.1/Organisation/search

Body:

{
  "CustomerID": 2070
}

Response:

[
  {
    "ID": 5740,
    "Name": "Example Organisation - Business",
    "KeychainCreationForNewUserActive": false,
    "KeychainEmailSuppression": false
  },
  {
    "ID": 5741,
    "Name": "Example Organisation - Care",
    "KeychainCreationForNewUserActive": false,
    "KeychainEmailSuppression": false
  }
]

Multiple Organisations

Most customers will only have one Organisation. Some may have multiple Centres requiring fully separated data and access.

3. Get Assessors in an Organisation

POST https://wsapibeta.onefile.co.uk/api/v2.1/User/Search/1/10

Body:

{
  "OrganisationID": 5740,
  "Role": 5
}

Response:

[
  {
    "ID": 122762,
    "FirstName": "James",
    "LastName": "Fayre",
    "MISID": "JFAYE51P"
  },
  {
    "ID": 132757,
    "FirstName": "Kate",
    "LastName": "Anderson",
    "MISID": "KANDREWS142"
  }
]

4. Get Classes in an Organisation

POST https://wsapibeta.onefile.co.uk/api/v2.1/Classroom/Search

Body:

{
  "OrganisationID": 5740
}

Response:

[
  {
    "ID": 15379,
    "Name": "Business Admin L2",
    "MISID": "BAD1"
  },
  {
    "ID": 15381,
    "Name": "Business Admin L3",
    "MISID": "BAD2"
  }
]

5. Get Placements in an Organisation

POST https://wsapibeta.onefile.co.uk/api/v2.1/Placement/Search

Body:

{
  "OrganisationID": 5740
}

Response:

[
  {
    "ID": 18928,
    "Name": "BT - Manchester",
    "MISID": "BT54810A"
  },
  {
    "ID": 18929,
    "Name": "Vodaphone - Salford",
    "MISID": "VP0491045X"
  }
]

6. Get Learners in an Organisation

POST https://wsapibeta.onefile.co.uk/api/v2.1/User/Search

Body:

{
  "OrganisationID": 5740,
  "Role": 1
}

Response:

[
  {
    "ID": 137945,
    "FirstName": "Gemma",
    "LastName": "Hall",
    "MISID": "GHALL391"
  },
  {
    "ID": 137946,
    "FirstName": "Chloe",
    "LastName": "Henshall",
    "MISID": "CHENSHALL194"
  }
]

Using This Data

Once downloaded, this data can be used to:

• Identify existing records in both systems
• Determine which users need updates
• Create new users where required
• Align MISIDs using Update endpoints

For more detailed learner fields (ULN, NINO, email, etc.), use the Paged User Search endpoints.

Next Guide

→ Creating and Managing Users via the API

Terminology

Terminology in this article may differ depending on your Centre.

Need Help?

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