Enums
AccessType
Access types, for groups at an area. Groups assigned to an area must have one or more access types. This determines how your connections can interact with that area.
Values
| Value | Description |
|---|---|
| Carrier | Connections in the group may be assigned as a carrier in bookings. In addition, they may make their own bookings, with themselves as the carrier. |
| PrivateOccupant | Connections in this group may be assigned as the on-site in bookings. The 'on-site' is the receiver if the task is inbound, or the sender if the task is outbound. Private occupants may only be set if the booking creator has a connection with the occupant when making the booking. |
| PublicOccupant | Connections in this group may be assigned as the on-site in bookings. The 'on-site' is the receiver if the task is inbound, or the sender if the task is outbound. Public occupants may be set even if the booking creator has no connection with the occupant. |
| PrivateOffsite | Connections in this group may be assigned as the off-site in bookings. The 'off-site' is the sender if the task is inbound, or the receiver if the task is outbound. Private offsites may only be set if the booking creator has a connection with the occupant when making the booking. |
| PublicOffsite | Connections in this group may be assigned as the off-site in bookings. The 'off-site' is the sender if the task is inbound, or the receiver if the task is outbound. Public offsites may be set even if the booking creator has no connection with the occupant. |
BookingNoticeType
Values
| Value | Description |
|---|---|
| Info | |
| Warning | |
| Danger |
BookingOrdering
Booking search ordering.
Values
| Value | Description |
|---|---|
| Code | Bookings will be ordered by their booking code. |
| Time | Bookings will be ordered by time. |
| Created | Order by created date |
| Modified | Order by modified date |
BookingSearchType
The type of a booking search time range
Values
| Value | Description |
|---|---|
| Scheduled | Search by scheduled datetime |
| Created | Search by creation datetime |
| Modified | Search by modified datetime |
BookingType
The type of a booking
Values
| Value | Description |
|---|---|
| Standard | A standard booking was created with the standard flow. |
| Instant | An instant booking was created as instant by the location, and bypassed the booking engine. |
| Recurring | A recurring type booking was created by a recurring booking configured by the location. |
| API | An API booking was created as instant or standard, but by an organisation token. |
| AccessCode | An Access Code booking was created by a pre-configured template in the specified status. It bypasses the booking engine. |
CapacityUnitLimitType
Throttle types, for unit limits.
Values
| Value | Description |
|---|---|
| Daily | |
| Simultaneous |
Colour
Colours. Included as reference are all colour hex values used in the official Mobiledock client.
Values
| Value | Description |
|---|---|
| Red | #e34963 |
| Green | #4bce93 |
| Blue | #40a2d9 |
| White | #ffffff |
| Black | #000000 |
| Grey | #808080 |
| Orange | #fb8362 |
| Purple | #8269df |
| Yellow | #f9bc6e |
| Brown | #79564d |
| Pink | #d34594 |
| LightRed | #ff758d |
| DarkRed | #bc1734 |
| LightGreen | #8be3bb |
| DarkGreen | #009953 |
| LightBlue | #8ac8eb |
| DarkBlue | #0c6699 |
| LightGrey | #bfbfbf |
| DarkGrey | #404040 |
| LightOrange | #ffbaa7 |
| DarkOrange | #cf5e3f |
| LightPurple | #b1a3e5 |
| DarkPurple | #4529ab |
| LightYellow | #ffd7a5 |
| DarkYellow | #c58a41 |
| LightBrown | #a88a82 |
| DarkBrown | #50332b |
| LightPink | #f18ac4 |
| DarkPink | #a71367 |
ConditionType
Values
| Value | Description |
|---|---|
| Time | This condition is based off times during the day |
| Week | This condition is based off days of the week |
| Year | This condition is based off dates in the yearly calendar |
| Vehicle | This condition is based off the location's vehicles |
| Load | This condition is based off the location's loads |
| BookingOption | This condition is based off the location's booking options |
| Space | This condition is based off the location's spaces |
| Group | This condition is based off the location's groups |
| DocumentStatus | This condition is based off the status of one or more documents |
| DocumentType | This condition is based off the type of one or more documents |
| LoadTag | This condition is based off a load tag present on one or more tasks |
| Direction | This condition looks at the inbound/outbound direction for all tasks |
| PointBlock | A special condition for blocking bookings from passing over a given time. |
| Organisation | This condition is based off an organisation |
| YardAssetType | This condition is based off a yard asset type |
Direction
A task's direction
Values
| Value | Description |
|---|---|
| Inbound | An inbound task has a receiver (the onsite), and may optionaly have a sender (the offsite) |
| Outbound | An outbound type has a sender (the onsite), and may optionally have a receiver (the offsite) |
DocumentAcknowledgementType
Defines a set of settings that determines the behaviour of a document.
Values
| Value | Description |
|---|---|
| Occupant | |
| Offsite | |
| Carrier |
DocumentFeatureStatusView
Sets the priorities configuration in the Task view. This enum must be synchronised with the enum Model respectively.
Values
| Value | Description |
|---|---|
| Disabled | Document feature is not allowed to be used. This option is set up by the Admin. |
| Off | Document feature disabled from the location |
| Required | Only document will be displayed as task in the booking view |
| OptionalDocument | Both document and basic task will be display but document will be the default option in booking view. |
| OptionalTask | Both document and basic task will be display but basic task will be the default option in booking view. |
DocumentMode
Defines a set of settings that determines the behaviour of a document.
Values
| Value | Description |
|---|---|
| Fixed | Initial document configuration cannot be changed at any stage after its creation. |
| Free | Initial document configuration can be changed at any stage after its creation. |
| Flexible | Initial document configuration can be changed at any stage after its creation. |
DocumentOrdering
Values
| Value | Description |
|---|---|
| Id | Documents will be ordered by their id. |
| CreationTime | Documents will be ordered by their creation time. |
| UpdateTime | Documents will be ordered by their update time. |
DriverMode
DriverMode is a location-level setting
Values
| Value | Description |
|---|---|
| Disabled | Do not allow drivers to be added to bookings. |
| Optional | Optionally allow drivers to be added to bookings. |
| Required | Drivers are required when creating bookings. |
FieldPosition
Choices for when a field should be captured.
Values
| Value | Description |
|---|---|
| Entering | The requisite field should be captured when entering the status. |
| Exiting | The requisite field should be captured when exiting the status. |
FieldType
The type of the field.
Values
| Value | Description |
|---|---|
| String | String type. |
| File | File type. The type of the file is unspecified. |
| Pass | Pass type. |
| Signature | Signature type. |
FileOrdering
Values
| Value | Description |
|---|---|
| Size | Files will be ordered by size. |
| CreationTime | Files will be ordered by creation or upload time. |
| LatestVersion | Files will be ordered by latest version. |
LoadBookingPosition
Setting for loads to determine where the load may be present.
Values
| Value | Description |
|---|---|
| Anywhere | The load may be present on the task or header level. |
| Header | The load will only ever be present on the header level. |
| Task | The load will only ever be present on the task level. |
ManualApprovalPolicy
Values
| Value | Description |
|---|---|
| Allowed | Bookings may always be submitted for manual approval. |
| Disallowed | Bookings may never be submitted for manual approval. |
| Fallback | Bookings may only be submitted for manual approval at a given time if there are no spaces available within a certain range. See the fallbackTimeRange property on organisation for the range in hours. |
Month
Months of the year.
Values
| Value | Description |
|---|---|
| January | January |
| February | February |
| March | March |
| April | April |
| May | May |
| June | June |
| July | July |
| August | August |
| September | September |
| October | October |
| November | November |
| December | December |
NotificationDeliveryType
Different ways a notification can be delivered.
Values
| Value | Description |
|---|---|
The notification will be delivered through an email, to the address registered in Mobiledock |
NotificationType
What types of notifications can be delivered.
Values
| Value | Description |
|---|---|
| BookingCreation | This event is triggered when a booking is created, and you are a carrier or location. |
| BookingRequiresManualApproval | This event is triggered when a booking enters the submittted status and requires manual approval. |
| BookingAutoApproved | This event is triggered when a booking is automatically approved, and you are a carrier or location. |
| BookingCompleted | This event is triggered when a booking enters the Completed status, and you are a carrier or location. |
| BookingException | This event is triggered when a booking enters any exception status, and you are a carrier or location. |
| BookingFlow | This event is triggered when a booking enters any non-exception non-core status, and you are a carrier or location. |
| BookingManualApproved | This event is triggered when a booking is manually approved, and you are a carrier or location. |
| BookingNewComment | This event is triggered on a new comment on a booking |
| MembershipAccepted | This event is triggered when someone accepts a membership invite. Receiving a membership invite has no notification event, and membership invite emails are always sent. |
| ConnectionCodeUsed | This event is triggered when someone uses a connection code from an organisation of yours. |
| ConnectionRequest | This event is triggered when someone requests a connection to one of your organisations. |
| ConnectionAccepted | This event is triggered when an organisation you've requested accepts a connection request. |
| TaskCreated | This event is triggered when a booking is created, and you are a receiver or sender. |
| TaskApproved | This event is triggered when a booking is approved, and you are a receiver or sender. |
| TaskCompleted | This event is triggered when a booking is completed, and you are a receiver or sender. |
| TaskFlow | This event is triggered when a booking enters any non-exception non-core status, and you are a receiver or sender. |
| TaskException | This event is triggered when a booking enters any exception status, and you are a receiver or sender. |
Permission
Available permissions in Mobiledock.
Values
| Value | Description |
|---|---|
| MembershipManagement | Membership management enables the ability to add and remove members of the organisation, as well as assign and unsassign roles to members. Users with this permission will be able to edit their own roles, effectively giving them ALL permissions. |
| ConnectionManagement | Connection management enables the ability to form new connections, remove existing connections, add and remove connection codes and accept or reject connection requests. |
| OrganisationAdministration | Organisation administration enables the ability to edit organisation settings and information, add and remove public organisation contacts and manage the organisations verification request. |
| OrganisationAnnouncements | Organisation announcements enables the ability to send email announcements to connected organisations. |
| LocationConfiguration | Location configuration enables the ability to modify settings related to booking capabilities and approvals. This includes: loads, vehicles, booking options, spaces, areas, groups, statuses, fields and recurring bookings. |
| BookingObservation | Booking observation enables the ability to view bookings where the organisation is referenced. |
| BookingParticipation | Booking participation enables the ability to participate in bookings where the organisation is referenced. This includes the ability to update status, cancel and add comments on a booking. |
| IntegrationManagement | Integrations management enables the ability to add and remove API integration tokens. |
| ReportsObservation | Reports observation enables the ability to view booking reports and statistics for the organisation. |
| ReportsManagement | Reports management enables the ability to create and update reports and report layouts. |
| DocumentObservation | Document observation enables the ability to query document(s) related to a specific organisation. |
| DocumentManagement | Document Management enables the ability to create, update and delete a document. |
| DriverObservation | Driver observation enables drivers to view bookings linked to them for the organisation. |
| InstantBookingCreation | Allowed to create instant bookings |
| BookingStatusOverride | Allowed to override Status |
| BookingSpaceAssignment | Allowed to set Space |
| BookingLoadOverride | Allowed to override loads |
| RecurringBookingManagement | Allowed to set recurring bookings |
| BookingFieldsOverride | Allowed to override fields |
| BookingTasksOverride | Allowed to override tasks |
| BookingHistoryOverride | Allowed to override history |
| BookingDriverOverride | Allowed to override driver |
| BookingVehicleOverride | Allowed to override vehicle |
| BookingCarrierReassign | Booking carrier Reassign indicates permission to carry out a carrer change on a booking. |
| BookingTaskReassign | Allowed to reassign tasks to other bookings. |
| PassManagement | Allowed to create/update and delete PassTypes and Passes |
| YardAssetManagement | Allowed to manage yard assets |
| YardAssetObservation | Allowed to observe yard assets |
| YardAssetParticipation | Allowed to participate with yard assets. Includes the ability to update a yard asset status. |
RuleType
Types of rules.
Values
| Value | Description |
|---|---|
| Allow | If an allow rule is matched, a booking can be assigned into the booking parameter combination that matched it. |
| Block | If a block rule is matched, then a booking won't be assigned into the booking parameter combination that matched it, even if allow rules otherwise accept it. |
Shape
Shapes, for icons.
Values
| Value | Description |
|---|---|
| None | No shape. |
| Square | Square. |
| Circle | Circle. |
| RoundedSquare | A square with rounded edges. |
| Diamond | Diamond. |
StateType
The type of a state
Values
| Value | Description |
|---|---|
| Active | |
| Deleted |
StatusType
Different types of statuses.
Values
| Value | Description |
|---|---|
| Submitted | The Submitted status is always the first status in the booking. It is a default status and cannot be removed. |
| Approved | The Approved status is the status that follows Submitted. It marks being assigned a space and time. It is a default status and cannot be removed. |
| Arrived | The Arrived status is the status that indicates the vehicle has arrived at the site. |
| Completed | The completed status is the last status in all bookings that complete successfully. It is a default status and cannot be removed. |
| Cancelled | The Cancelled status is an exception status for a generic 'failed' booking/ It is a default status and cannot be removed. |
| Flow | Flow statuses represent normal statuses for a booking to be in. Flow statuses are user-defined. |
| Exception | Exception statuses represent specific failure states of a booking. Exception statuses are user-defined. |
| Receipting | The receipting status is the status that allows you to see planned tasks. |
TaskDirectionMode
The location-level TaskDirectionMode setting controls whether inbound or outbound tasks are permitted. If a document is referenced on a task, the direction defined by the document will be used and may override this setting. This setting does not affect bookings created by instant bookings or recurring bookings.
Values
| Value | Description |
|---|---|
| InboundDefault | In this mode, both inbound and outbound tasks are permitted. The default value in the UI is Inbound. |
| InboundOnly | In this mode, only inbound tasks are permitted. |
| OutboundDefault | In this mode, both inbound and outbound tasks are permitted. The default value in the UI is Outbound. |
| OutboundOnly | In this mode, only outbound tasks are permitted. |
TransitionType
Base times for the status auto-transition feature
Values
| Value | Description |
|---|---|
| BookingStart | Base transition time will be at the start of the scheduled booking |
| BookingEnd | Base transition time will be at the end of the scheduled booking |
| StatusTransition | Base transition time will be when this status is assigned to the booking |
| RequestStart | Base transition time will be at the start of the requested booking |
| RequestEnd | Base transition time will be at the end of the requested booking |
Weekday
Days of the week.
Values
| Value | Description |
|---|---|
| Monday | Monday |
| Tuesday | Tuesday |
| Wednesday | Wednesday |
| Thursday | Thursday |
| Friday | Friday. Best day of the week! |
| Saturday | Saturday |
| Sunday | Sunday |
YardAssetStatusType
Yard asset status types used for asset tracking.
Values
| Value | Description |
|---|---|
| Submitted | |
| Approved | |
| Arrived | |
| Completed | |
| Exception |
YardMode
Values
| Value | Description |
|---|---|
| Disabled | Yard asset input is not allowed to be used. This option is set up by the Admin. |
| Off | Yard asset input switched off for the location |
| Optional | Users can optionally provide yard assets |
| Required | Users must provide yard assets |