Skip to content

OrganisationReference

An organisation reference. Contains a limited subset of the information from an organisation.

General 29
FieldTypeDescription
id*UUID!The ID of the organisation.
name*String!The name of the organisation.
description*String!The description of the organisation.
addressPhysicalAddressThe address of the organisation.
timezone*String!The timezone the organisation resides in.
contacts*[Contact!]!A list of contacts for the organisation.
verified*Boolean!Whether the organisation has been verified. To become verified, you must contact Mobiledock.
allowConnectionRequests*Boolean!Whether people can request connections to the organisation. Changing this to false does not cancel any current connection requests.
taskInstructionsStringInstructions to be displayed on the booking wizard, in relation to creating your tasks.
timeInstructionsStringInstructions to displayed on the Time Selection page of the booking process.
requireInstructionsAcknowledgement*Boolean!Whether users must acknowledge instructions before proceeding with booking.
pickAreaOnCreateBooking*Boolean!Whether you have to pick your area on booking creation or not. When true, you must include a area ID with the booking creation When false, you must not include an area ID with booking creation. An area will be assigned to you.
mandatoryOffsiteOnCreate*Boolean!Whether the task offsite (sender for Inbound, receiver for Outbound) must be provided when a booking is created.
driverMode*DriverMode!Driver mode of the current location.
logoUrlStringcompany logo url
logoImagecompany logo url
logoDarkBackgroundImagedark mode company logo url
maxFileSize*Int!The maximum file size (in bytes) that can be uploaded to a field in this organisation.
minimumBookingOptionsSelectedIntThe minumum number of booking options that may be selected on each task.
maximumBookingOptionsSelectedIntThe maximum number of booking options that may be selected on each task.
maximumTaskCountIntThe maximum number of tasks that can be added. If null, there is no limit.
base*Boolean!Whether the current org is a base organisation.
pass*Pass!Look to see if pass matching all the criteria exists Pass can only be queried if the querying user is a member of an organisation connected to the location. Pass belongs to the parent org (eg location), pass.organisationid is the users org (eg carrier)
taskDirectionMode*TaskDirectionMode!Determines what direction tasks are permitted to be when creating a standard booking at this location.
yardMode*YardMode!Determines if yard features are enabled at this location.
yardAssetTypes*[YardAssetTypeReference!]!Yard asset types configured for this organisation.
domainStringThe domain of the organisation.
industryStringtext version of the industry enum the org is linked to
formsEnabled*Boolean!Whether this organisation has forms enabled.
Location 1
FieldTypeDescription
locationEnabled*Boolean!Whether location functionality is enabled for the organisation. If location is disabled, the organisation cannot create areas or spaces, or participate in bookings as a location. This does not prevent them from participating in bookings as a sender, carrier, or receiver. To enable location functionality, you must contact Mobiledock.
Booking 3
FieldTypeDescription
bookingInstructionsStringInstructions to be displayed on every booking at, and when booking at this location.
bookingOptions*[BookingOption!]!All booking options available for a booking at this location.
bookingNotices*[BookingNotice!]!only shows booking notices that intersect with a specified time range
Field 1
FieldTypeDescription
fields*[FieldReference!]!All fields able to be filled for bookings or assigned to statuses for the other organsiation.
Status 1
FieldTypeDescription
statuses*[StatusReference!]!All statuses available for a booking at this location.
Load 1
FieldTypeDescription
loads*[LoadReference!]!All loads available for a booking at this location
Document 1
FieldTypeDescription
documentFeatureStatus*DocumentFeatureStatusView!Configures the document's view mode for the booking's task.