ACE360 Connect Documentation

Appearance

On this page

Booking Data Explained ​

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

Contents ​

id ​

Example:

json
"id": 1

This is the ACE360 internal ID for the booking.

status ​

Example:

json
"status": "confirmed"

Possible values: pending, epao_action_required, confirmed, completed, cancelled, cancellation_requested

bookingType ​

Example:

json
"bookingType": "online"

Possible values: online, in_person

bookingDate ​

Example:

json
"bookingDate": "2024-01-23"

startTime ​

Example:

json
"startTime": "09:00"

endTime ​

Example:

json
"endTime": "13:30"

streetAddress ​

Example:

json
"streetAddress": "1 Apple Street"

city ​

Example:

json
"city": "Big City"

postcode ​

Example:

json
"postcode": "AA1 1AA"

Example:

json
"meetingLink": "https://example-meeting-link"

This field can be used to store a meeting link (e.g. Teams, Zoom, etc) for online bookings.

epas ​

Example:

json
"epas": [
    {
        "id": 2933,
        "typeId": 4
    },
    {
        "id": 2934,
        "typeId": 9
    },
],

This is an array of the EPAs associated with the booking.

The id and typeId are internal ACE360 IDs. You will be able to use these IDs to query for more information when the releveant ACE360 Connect endpoints become available.

apprentices ​

Example:

json
"apprentices": [
    {
        "id": 245,
        "attended": true
    }
],

This array contains all of the apprentices that are associated with the booking. The apprentice id can be used to look up more information about the apprentice.

Note that there are three possible values for the attended field: true, false, and null.

If the assessor has not yet recorded attendance for the booking, then then the attended value will be null for all apprentices on the booking.

equipmentRequired ​

Example:

json
"equipmentRequired": "A description of equipment required for the booking."

dressCode ​

Example:

json
"dressCode": "A description of the dress code required for the booking."

ppe ​

Example:

json
"ppe": "A description of the personal protective equipment required for the booking."

additionalNotes ​

Example:

json
"additionalNotes": "Any additional notes for the booking."

epaoInvigilatorRequired ​

Example:

json
"epaoInvigilatorRequired": true

cancellationReason ​

Example:

json
"cancellationReason": "A description of why the booking was cancelled."

cancellationRequestReason ​

Example:

json
"cancellationRequestReason": "A description of why a cancellation request was made."

availabilityInformation ​

Example:

json
"availabilityInformation": "Information relating to assessor availability."

attendanceRecordedAt ​

Example:

json
"attendanceRecordedAt": "2023-11-15 14:10:30"

This timestamp refers to the time that the assessor recorded the attendance in ACE360. Note that this may be some time after the booking has taken place.

createdAt ​

Example:

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

This refers to the time that the booking was created in ACE360.