Queries

allowedFileTypes

Type: [ID!]

Return global MD allowed file types

allPermissions

Type: [Permission!]!

Get permissions list without needing introspection

availableBookingTimeRanges

Type: [BookingRange!]!

Get all available times for a given candidate booking, in a time range. Fields correspond to the requisite fields in creating a booking. Anything that would cause CreateBooking to fail causes failure here. TimeRange cannot be greater than 24 hours.

This call has been deprecated in favour of availableBookingTimeRangesReason

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location on the candidate booking
carrierId UUID!	The ID of the carrier on the candidate booking
subcarrierId UUID	The ID of the subcarrier on the candidate booking
vehicleId UUID!	The ID of the vehicle on the candidate booking
areaId UUID	The ID of the area on the candidate booking
tasks [TaskInput!]!	An array of inputs containing task details for the candidate booking
range TimeRange!	The requested time range. Cannot be greater than 24 hours
bookingId ID	optional booking Code to modify
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

availableBookingTimeRangesReason

Type: BookingRangeReason!

Get all available times for a given candidate booking, in a time range. Fields correspond to the requisite fields in creating a booking. Anything that would cause CreateBooking to fail causes failure here. TimeRange cannot be greater than 24 hours.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location on the candidate booking
carrierId UUID!	The ID of the carrier on the candidate booking
subcarrierId UUID	The ID of the subcarrier on the candidate booking
vehicleId UUID!	The ID of the vehicle on the candidate booking
areaId UUID	The ID of the area on the candidate booking
tasks [TaskInput!]!	An array of inputs containing task details for the candidate booking
range TimeRange!	The requested time range. Cannot be greater than 24 hours
bookingId ID	optional booking Code to modify
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

availableBookingTimes

Type: [BookingTime!]!

Get all available times in a range. Fields correspond to the requisite fields in creating a booking. Anything that would cause CreateBooking to fail causes failure here. TimeRange cannot be greater than 1 hour.

This call has been deprecated in favour of availableBookingTimesReason

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location on the candidate booking
carrierId UUID!	The ID of the carrier on the candidate booking
vehicleId UUID!	The ID of the vehicle on the candidate booking
areaId UUID	The ID of the area on the candidate booking
tasks [TaskInput!]!	An array of inputs containing task details for the candidate booking
range TimeRange!	The requested time range. Cannot be greater than 1 hour
bookingId ID	optional booking Code to modify
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

availableBookingTimesReason

Type: BookingTimeReason!

Get all available times in a range. Fields correspond to the requisite fields in creating a booking. Anything that would cause CreateBooking to fail causes failure here. TimeRange cannot be greater than 1 hour.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location on the candidate booking
carrierId UUID!	The ID of the carrier on the candidate booking
subcarrierId UUID	The ID of the subcarrier on the candidate booking
vehicleId UUID!	The ID of the vehicle on the candidate booking
areaId UUID	The ID of the area on the candidate booking
tasks [TaskInput!]!	An array of inputs containing task details for the candidate booking
range TimeRange!	The requested time range. Cannot be greater than 1 hour
bookingId ID	optional booking Code to modify
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

bookableAreas

Type: [AreaReference!]!

Given an organisation making a booking, get a list of all the valid areas if you were to book at a location. Area ID is required if the location requires you to select an area on creating a booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location where the booking is to be made
carrierId UUID!	The ID of the carrier to be on the booking

bookableCarriers

Type: [OrganisationReference!]!

Given an organisation making a booking, get a list of all the valid carriers if you were to book at a location. Area ID is required if the location requires you to select an area on creating a booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location where the booking is to be made
areaId UUID	The ID of the area where the booking is to be made

bookableDocument

Type: Document

Return a document is it is able to be booked

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location on the candidate booking
carrierId UUID!	The ID of the carrier on the candidate booking
documentId ID!	The ID of the document
existingBookingId ID	The existing booking ID for specific use cases

bookableDocumentList

Type: [DocumentResult!]!

Return a list of documents if it is able to be booked

Arguments

Name	Description
organisationId UUID!
locationId UUID!
carrierId UUID!
subcarrierId UUID
documentIds [ID!]!
existingBookingId ID

bookableLocations

Type: [BookableLocations!]!

Get a list of all locations you can make a booking at, regardless of what position in the booking you take.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking

bookableYardAsset

Type: [YardAssetLink!]!

Return a list of yard assets that are able to be booked

Arguments

Name	Description
organisationId UUID!
locationId UUID!
yardAssetExternalId ID!
existingBookingId ID

booking

Type: Booking

Get a single booking, identified by ID.

To see a booking for which an organisation of yours is the location at, you must have the ViewLocationBookings permission for the location. To see a booking for which an organisation of yours is the carrier for, you must have the ViewCarrierBookings permission for that organisation.

If the booking is present at multiple of your organisations, you only need permission from one to see it.

Arguments

Name	Description
id ID!	The ID of the booking

bookingConfigurationErrors

Type: [BookingError!]!

Check a booking configuration for validity. Returns an array of errors, if any are invalid. If the array is empty, the booking is a valid booking and can be created.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
locationId UUID!	The ID of the location on the booking configuration
carrierId UUID!	The ID of the carrier on the booking configuration
vehicleId UUID!	The ID of the vehicle on the booking configuration
areaId UUID	The ID of the area on the booking configuration
tasks [TaskInput!]!	An array of inputs containing task details for thebooking configuration
headerLoads [LoadQuantityInput!]
driver DriverIdentifier	Driver identifier input
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

bookingNextStatuses

Type: [Status!]!

Return the statuses that the given booking can move to, when updated by the given organisation. This does not count booking status overrides.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking

bookingParameters

Type: BookingParameters!

Returns the set of all interesting parameters needed to create a booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the booking
carrierId UUID!	The ID of the carrier to be on the booking
locationId UUID!	The ID of the location to be on the booking
subcarrierId UUID	The ID of the subcarrier on the candidate booking
areaId UUID	The ID of the area to be on the booking

bookingPin

Type: Booking

Get a single booking, based on PIN code.

If there's a booking with the given PIN scheduled close to the time you request, this call will return it. PIN codes are guaranteed to be unique in a range of +/-72h from the booking - so long as the time given is within 72h of the booking time, the correct booking will be returned.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
pin ID!	The PIN code of the booking
time Timestamp	The time of the booking

bookings

Type: BookingQuery!

Search bookings.

To see a booking for which an organisation of yours is the location at, you must have the ViewLocationBookings permission for the location. To see a booking for which an organisation of yours is the carrier for, you must have the ViewCarrierBookings permission for that organisation.

If the booking is present at multiple of your organisations, you only need permission from one to see it. Up to 1000 bookings may be returned at a time. Start and count adjust paging, while ordering adjusts ordering. Count cannot go above 1000.

Arguments

Name	Description
filter BookingsFilterInput	The inclusive filter on bookings that will be returned
start Int	The index of the first booking in the list to be returned
count Int	The number of bookings to be returned. Max 1000
ordering BookingOrdering	The ordering method of the bookings being returned
ascending Boolean	A flag indicating whether the bookings are in ascending order by the ordering method. True indicates ascending order. False indicates descending order.

bookingsV2

Type: BookingQuery!

Arguments

Name	Description
filter BookingsFilterInputV2	The inclusive filter on bookings that will be returned
start Int	The index of the first booking in the list to be returned
count Int	The number of bookings to be returned. Max 1000
ordering BookingOrdering	The ordering method of the bookings being returned
ascending Boolean	A flag indicating whether the bookings are in ascending order by the ordering method. True indicates ascending order. False indicates descending order.

connectionCodeDetails

Type: ConnectionCodeDetails

Get the details from a particular active connection code.

Arguments

Name	Description
code String!	The connection code

documents

Type: DocumentQuery!

The documents query returns a list of documents that your organisation has access to

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the query
filter DocumentsFilterInput	The filters to apply to the search
start Int	The index of the first booking in the list to be returned
count Int	The number of bookings to be returned. Max 1000
ordering DocumentOrdering	The ordering method of the documents being returned.
ascending Boolean	A flag indicating whether the documents are in ascending order by the ordering method. True indicates ascending order. False indicates descending order.

entityClassMap

Type: EntityClassMap!

fetch data about any defined entity classes

incomingMembershipInvites

Type: [MembershipInvite!]!

A list of organisations you have been invited to.

memberOrganisations

Type: [Organisation!]!

Query all the organisations you are a member of.

notificationSettings

Type: [NotificationTypeSetting!]!

Your notification type settings.

organisation

Type: Organisation

Query a single organisation you are a member of.

Arguments

Name	Description
id UUID!	The ID of the organisation

organisationReference

Type: OrganisationReference

Query a single organisation.

Arguments

Name	Description
id UUID!	The ID of the organisation

organisations

Type: [OrganisationReference!]!

Search multiple organisations.

Arguments

Name	Description
filter OrganisationFilter	The inclusive filter on organisations to be returned

rulesTest

Type: RulesTest!

Check a specific booking's settings against a specific date-time. Returns a more extensive reason why the booking failed, than availableBookingTimesReason or availableBookingTimeRangesReason.

You must have the 'LocationConfiguration' permission at the organisation to use this call.

Arguments

Name	Description
organisationId UUID!	The ID of the location organisation.
locationId UUID!	The ID of the location on the booking configuration
carrierId UUID!	The ID of the carrier on the candidate booking
subcarrierId UUID	The ID of the subcarrier on the candidate booking
vehicleId UUID!	The ID of the vehicle on the candidate booking
areaId UUID	The ID of the area on the candidate booking
tasks [TaskInput!]!	An array of inputs containing task details for the candidate booking
time Timestamp!	The time to check.
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

user

Type: User!

Query your user account.

yardAssets

Type: YardAssetQuery!

Yard assets query

Arguments

Name	Description
yardAssetQuery YardAssetsQueryInput!