OData dictionary

Overview

The attached excel workbook lists the common fields found in the Aptem OData feed. The data is stored across 33 tables listed below.

1. AimWorkPlacements
2. ApprenticeshipFinancialRecords
3. AptemCognitiveAssessments
4. AwardingBodyQualifications
5. AwardingBodyQualificationsAssessmentHistory
6. ComplianceDocuments
7. ComponentDueDateChanges
8. CrmActivities
9. DestinationProgressions
10. EmployerGroups
11. EPAErrors
12. Episodes
13. Groups
14. IlrAims
15. Jobs
16. LearnerEmployment
17. LearningPlanComponents
18. LearningPlanEvidences
19. LearningPlanEvidenceWithActivityData
20. MaximumProgrammeDataFields
21. Messages
22. Milestones
23. Notes
24. OnboardingResponses
25. OrganizationContacts
26. Organizations
27. ReviewResponses
28. Reviews
29. Tasks
30. Trackers
31. UserGroups
32. Users
33. WithdrawalReasons

The exact list of fields will vary across customer systems depending on the use of bespoke data collection in, for example, reviews and onboarding processes.

To view the list of fields in your account, use this url format:  https://your_tenant_name.aptem.co.uk/odata/1.0/$metadata

The attached excel file lists all common fields, and can be filtered by table, fieldname etc.

Example data/descriptions are also provided for some fields.

What's new in this version:

• The /odata/1.0/LearnerEmployment feed has been rewritten to remove duplicate rows and correct inaccurate employment end dates, so each learner now returns at most one row per employment status.

• Unqualified requests to /odata/1.0/LearnerEmployment are now capped at 5,000 rows, in line with other OData feeds. Use $top and $skip to page through larger datasets; requests with $top set above 5,000 are rejected with a 400 error.

Using the new OData v2 API

A new version of the OData API, v2, is now available at /odata/2.0/. It has its own full interactive documentation, including datasets, fields, query options, pagination, and response codes, published at /odata/2.0/docs on your usual Aptem web address (with an OpenAPI spec and an AI-assistant-friendly version also available there).

If you're integrating against v2 feeds, use that documentation as your primary reference. This dictionary continues to describe the existing v1.0 feed.

Rate limits: requests to the v2 API are limited by default to 120 requests per minute and 4 concurrent requests, per tenant, user, endpoint, and version. Requests over the limit receive a standard 429 response.