ACE360 Connect Documentation

Appearance

On this page

Apprentice Data Explained ​

The following is a list of data fields returned by the ACE360 Connect apprentice and apprentices endpoints. We've written this reference guide to help you better understand the data you receive from Connect.

Contents ​

id ​

Example:

json
"id": 249

This is the unique identifier for an apprentice in ACE360. Commonly referred to as an ACE ID.

firstName ​

Example:

json
"firstName": "Lucy"

The first name of an apprentice.

lastName ​

Example:

json
"lastName": "Smith"

The last name of an apprentice.

ulnNumber ​

Example:

json
"ulnNumber": "3000600342"

An apprentice's unique learner number.

dateOfBirth ​

Example:

json
"dateOfBirth": "2010-02-19"

An apprentice's date of birth.

gender ​

Example:

json
"gender": "Female"

An apprentice's gender.

ethnicGroup ​

Example:

json
"ethnicGroup": "English/Welsh/Scottish/Northern Irish/British"

An apprentice's ethnic group.

standardId ​

Example:

json
"standardId": 204

The standard an apprentice is on. You will be able to use this id to get standard information from our standards endpoint.

status ​

Example:

json
"status": {
"id": 3,
"text": "Gateway Evidence Complete"
}

The current status of an apprentice in ACE360.

The list of statuses are:

json
1	In Training
2	Gateway in Progress
3	Gateway Evidence Complete
4	Gateway Submitted
5	Approved for EPA
6	Denied EPA
7	EPA in Progress
8	EPA Evidence Complete
9	EPA Passed
10	EPA Failed

tpoId ​

Example:

json
"tpoId": 57

The ID of the TPO the apprentice is associated with. Can be used to fetch more information from the TPOs endpoint.

epaOverallGrade ​

Example:

json
"epaOverallGrade": "pass"

The overall grade an apprentice achieved at the end of EPA.

epaProvisionalGrade ​

Example:

json
"epaProvisionalGrade": "merit"

The provisional grade an apprentice was assigned at the end of EPA.

epaoRegisteredDate ​

Example:

json
"epaoRegisteredDate": "2023-12-12"

This is the date when an EPAO is assigned to an apprentice.

estimatedStartDate ​

Example:

json
"estimatedStartDate": "2023-10-23"

This is the apprenticeship start date of the apprentice as determined by the training providor. Should match the ILR return of the training provider.

estimatedEndDate ​

Example:

json
"estimatedEndDate": "2028-01-29"

This is the date at which the apprentice is expected to reach gateway.

estimatedGatewayAtEpaoRegistration ​

Example:

json
"estimatedGatewayAtEpaoRegistration": "2024-03-06 00:00:00"

Expected gateway date at the point of registration with the EPAO.

esfaCertificateClaimedAt ​

Example:

json
"esfaCertificateClaimedAt": "2022-10-22 17:18:39"

Date at which an apprentice’s certificate reference is claimed from the ESFA.

epaoNotes ​

Example:

json
"epaoNotes": "These is a example EPAO note"

These are notes attached to the apprentice which are only visible to the EPAO.

createdAt ​

Example:

json
"createdAt": "2023-10-23 07:08:38"

Date when the record was created.

updatedAt ​

Example:

json
"updatedAt": "2023-10-23 07:08:38"

Date when the record was last updated. This is updated to the present time when an apprentice:

  • Has their personal information updated
  • Is archived or unarchived
  • Changes status
  • Changes AO
  • Has a certificate delivery address added
  • An EPA grade is assigned to them
  • Overall gateway notes are added or changed
  • AO notes are added or changed
  • Is withdrawn
  • Is restored after withdrawal
  • Enters a break in learning
  • Resumes learning

archivedAt ​

Example:

json
"archivedAt": "2023-11-06 14:40:32"

Date at which the record has been archived (only old records will have this).

gradeDate ​

Example:

json
"gradeDate": "2023-10-31 12:33:59"

Date at which an apprentice received their final grade.

approvedForEpaDate ​

Example:

json
"approvedForEpaDate": "2023-10-31 12:33:59"

Date at which the epao has approved the gateway submitted by the training provider.

epaoInternalId ​

Example:

json
"epaoInternalId": "epao_internal_id_123"

This field is only visible to EPAOs.

archivalStatus ​

Example:

json
"archivalStatus": "auto_archived"

This field corresponds to an apprentice's archival status and has 5 possible values:

"withdrawn"
"break_in_learning"
"auto_archived"
"archived"
null

reasonableAdjustmentRequestedAt ​

Example:

json
"reasonableAdjustmentRequestedAt": "2024-07-22 12:00:43"

Date at which the training provider requested a reasonable adjustment.

reasonableAdjustmentApprovedAt ​

Example:

json
"reasonableAdjustmentApprovedAt": "2024-07-22 12:00:43"

Date at which the epao approved the reasonable adjustment.

reasonableAdjustmentRejectedAt ​

Example:

json
"reasonableAdjustmentRejectedAt": "2024-07-22 12:00:43"

Date at which the epao rejected the reasonable adjustment.

email ​

Example:

json
"email": "[email protected]"

The email of an apprentice.

learningSupport ​

Example:

json
"learningSupport": "Other physical disability"

This field indicates if an apprentice has disabilities.

gatewaySubmittedDate ​

Example:

json
"gatewaySubmittedDate": "2025-02-19 21:25:20"

Date at which the training provider submitted gateway to the EPAO.

epaInProgressDate ​

Example:

json
"epaInProgressDate": "2025-02-19 21:25:20"

Date at which the EPAO starts the EPA process for an apprentice after approving gateway.

deniedEpaDate ​

Example:

json
"deniedEpaDate": "2025-02-19 21:25:20"

Date at which the EPAO has rejected the gateway submitted by the training provider.

funding ​

Example:

json
"funding": "false"

This field indicates if funding is required for an apprentice.

fundingType ​

Example:

json
"fundingType": "Unfunded"

This is the type of funding for an apprentice. If no funding option has been provided, this will return null.

The list of funding types are:

"Employer levy"
"Employer levy and co investment"
"Government employer co investment"
"Unfunded"

ulnValidated ​

Example:

json
"ulnValidated": "false"

This field indicates if the apprentice's ULN is validated by the EPAO.

employer ​

Example:

json
"employer": {
    "name": "Tom Ford",
    "sectorId": 1,
    "sector": "Engineering and Manufacturing",
    "street": "1 Apple Street",
    "city": "Big City",
    "county": "Nice County",
    "country": "United Kingdom",
    "postcode": "AA1 1AA",
    "email": "[email protected]",
    "contactFirstName": "Jim",
    "contactLastName": "Smith",
    "contactPosition": "CEO",
}

These are the details of the apprentice's employer.

street ​

Example:

json
"street": "1 Apple Street"

The apprentice's street.

city ​

Example:

json
"city": "Big City"

The apprentice's city.

county ​

Example:

json
"county": "Nice County"

The apprentice's county.

postcode ​

Example:

json
"postcode": "AA1 1AA"

The apprentice's postcode.

country ​

Example:

json
"country": "United Kingdom"

The apprentice's country.

telephoneNumber ​

Example:

json
"telephoneNumber": "01234567890"

The apprentice's telephone number.