openapi: 3.0.0
info:
title: Opendock Nova API Documentation Appointments Users API
description: "## Welcome to Opendock Nova!\n\n#### What is Opendock Nova?\n\nOpendock is an online dock appointment scheduling tool. Facilities such as warehouses, distribution centers, and\nmanufacturing plants use it to organize their docks and schedule appointments for outbound pickups and inbound\ndeliveries.\nYou can read all our knowledge base\narticles [here.](https://community.loadsmart.com/hc/en-us/sections/24987828169619-Opendock-Nova-Warehouse-API)\n\nWe now provide an SSO option for User Authentication. Read\nthe [docs here.](https://community.loadsmart.com/hc/en-us/articles/14944624317075-Single-Sign-On-SSO-SAML-2-0)\n\n---\n\n## Our APIs\n\nWe have 3 main APIs:\n\n- REST API called _Neutron_ for performing standard HTTP operations.\n- Real-time API called _Subspace_ for receiving streaming events whenever objects are Created/Updated/Deleted.\n- A **\"Reference Number Validation\"** aka \"PO Validation\" _protocol_ for validating PO numbers (or similar) before an\n appointment is scheduled. Detailed documentation for it can be found\n here: [PO/Ref Number Validation Implementation](https://community.loadsmart.com/hc/en-us/articles/14946368437907-PO-Ref-Number-Validation-Implementation)\n\n---\n\n## Neutron - REST API\n\nAll endpoints are listed below. Depending on your User Role, some may be forbidden. Almost all endpoints expect a simple\nJWT token to be set in the `Authorization: Bearer` HTTP header. Read more about Bearer\ntokens [here](https://swagger.io/docs/specification/authentication/bearer-authentication/).\n\n### Base URL\n\nThe base URL is the same as it is for this document (look at the current URL in your browser's address bar). For\nexample, our production Neutron Base URL is [https://neutron.opendock.com](https://neutron.opendock.com).\n\n### Authentication\n\nTo start, call the `POST /auth/login` endpoint to exchange your user credentials (email + password) for a simple JWT\ntoken. If you don't have an account yet, reach out to your account admin or contact us for further help.\n\nIf login is successful, the response will be a JWT token to use as your `Bearer` header as described above.\n\nThe JWT expiration time depends on your User Role as well as other factors. You may base64-decode your JWT token to view\nmore technical details about it.\n\n#### Test it:\n\nTo test that your auth headers are set correctly, call the `GET /auth/me` endpoint. It will return a JSON payload with\nyour User information.\n\n---\n\n## Subspace - Real-time Streaming API\n\nSubspace is a _read-only_ API that allows your system to recieve streaming real-time information about changes to your\nAppointments, Warehouses, Docks, etc.\n\nUsing Subspace you can implement a \"push\"-based approach to your integration instead of relying only on \"poll\"-ing\nmethods (which can be inefficient).\n\nSubpsace is based on the famous [`socket.io`](https://socket.io/) library.\n\n### Choosing a socket.io Client\n\nThe socket.io project provides a JavaScript client library that works in the browser as well as NodeJS. However there\nare also client implementations in many other languages including C#, Java, Python, and Go, so you should select the\nappropriate client for your project. A good overview of socket.io and a list of client implementations can be found\nhere: [Socket.IO Introduction](https://socket.io/docs/v4/)\n\n**NOTE:** Currently Opendock uses socket.io server **v4.x** so please make sure to select an appropriate socket.io\nclient version that is protocol compatible.\n\n### Connecting and Authentication\n\nThe base connection URL is the same as the base URL for Neutron above, except with the word \"subspace\" instead of \"\nneutron\". For example, our production Subspace connection URL\nis [wss://subspace.opendock.com](wss://subspace.opendock.com).\n\nFor convenience, the same JWT token obtained from the Neutron `/auth/login` endpoint above is used for Subspace\nauthentication.\n\nConnecting and Authenticating are done in a single operation: simply connect to the following `wss` URL:\n\n```\n<Connection URL>?token=<JWT Token>\n```\n\nThat can be a little confusing to parse. Here's a real-life example connection string:\n\n```\nwss://subspace.opendock.com?token=eyJhbGciOiJIUzI1Ni...(full token continues)\n```\n\n**NOTE:** Currently Opendock only supports the `websocket` transport, so you must specify this in your connection\nsettings.\n\nHere's an example of connecting to Subspace using the JavaScript client:\n\n```JavaScript\n// NOTE: we assume \"accessToken\" was already obtained earlier via a call to '/auth/login'.\nconst baseSubspaceUrl = 'wss://subspace.opendock.com';\nconst url = `${baseSubspaceUrl}?token=${accessToken}`;\nconst socket = io(url, { transports: ['websocket'] }); // Enforce 'websocket' transport only.\n```\n\n### Listening to events\n\nSubspace emits Create/Update/Delete events for each entity in your Org (Appointment, Warehouse, Dock, etc). Your event\nhandler for these events will receive a JSON object containing the details about the given entity.\n\nOnce your socket.io client instance is connected, you can listen for any of these events by constructing the appropriate\nevent string:\n\nEvent strings follow this pattern:\n\n```\n\"{EventType}-{EntityName}\"\n```\n\n`EventType` can be one of: `create`, `update`, or `delete`.\n\n`EntityName` can be any entity in our REST API, such as: `Appointment`, `Warehouse`, `Dock`, etc.\n\nSo for example, to listen to `create` events for `Appointment` entities you would use:\n\n```\n\"create-Appointment\"\n```\n\nOr to listen to `update` events for `Warehouse` entities you would use:\n\n```\n\"update-Warehouse\"\n```\n\n**NOTE:** The event types are lowercase, but the entity names are capitalized (event strings are case-sensitive).\n\nThere is also a `\"heartbeat\"` event that you can listen to, which will emit every 5 seconds with a timestamp and the\nNeutron API version. This can be helpful for ensuring that your connection to Subspace is working correctly.\n\n### Caveats and Limitations\n\nSubspace does not do any sort of \"catch-up\" or \"replay\" of events, you will only get the events that occur after you\nconnect to the socket.io server.\n\nIf your client loses connection for some time, the event messages will not be queued and delivered when you next\nconnect, you will simply start receiving new messages after the point in time that you connected.\n\nFor this reason, even when using Subspace, you may need to occasionally supplement with calls to our REST API (ie.\ngetAll) to fetch entities and keep in sync with the data in Opendock, depending on your needs.\n\n### Example: Listening for Heartbeat\n\nThis event handler will get called periodically with the \"heartbeat\" information:\n\n```JavaScript\nsocket.on('heartbeat', (data) => {\n console.log(data);\n});\n```\n\nThis will output something like:\n\n```JSON\n{\n now: '2022-09-15T20:02:20.015Z',\n version: {\n major: '2',\n minor: '5',\n patch: '16',\n commit: '4a443fb\\n'\n }\n}\n```\n\n### Example: Listening for Appointment Creation and Update\n\nIn this example, your event handler will get called whenever an Appointment\nis created in your Org:\n\n```JavaScript\nsocket.on('create-Appointment', (data) => {\n console.log('appt create:', data);\n});\n```\n\nThe `data` your event handler recieves will be a JSON object containing\nthe Appointment details, like this:\n\n```JSON\n{\n \"id\": \"9cd63603-a7ff-43c7-8183-befc19a7a81b\",\n \"createDateTime\": \"2022-07-29T06:49:20Z\",\n \"lastChangedDateTime\": \"2022-07-29T06:49:20Z\",\n \"isActive\": true,\n \"tags\": [],\n \"type\": \"Standard\",\n \"status\": \"Scheduled\",\n \"start\": \"2022-07-29T00:00:00+00:00\",\n \"end\": \"2022-07-29T01:30:00+00:00\",\n ...\n ...\n ...\n}\n```\n\nIf you also wanted to listen for any changes to existing Appointments\nyou could add another listener:\n\n```JavaScript\nsocket.on('create-Appointment', (data) => {\n console.log('appt create:', data);\n});\n\nsocket.on('update-Appointment', (data) => {\n console.log('appt update:', data);\n});\n```\n\nThe `update-Appointment` event handler will receive a similar JSON object\ncontaining the most up-to-date details of the Appointment that was\njust updated.\n\n---\n\n## Nestjsx/Crud\n\n[NestJSX/Crud](https://github.com/nestjsx/crud/wiki/Requests#search) is a robust library designed for creating\nhigh-performance and scalable APIs. With NestJSX/Crud, API\nconsumers can take advantage of a flexible and intuitive approach to querying data.\n\nThis library streamlines the process of searching, sorting, and paginating data to cater to the exact requirements of\nthe API consumer. This feature saves valuable time by allowing the API consumer to bypass irrelevant data, ensuring only\nthe necessary data is obtained.\n\nNote: We encourage use of the `search` parameter (`s=...`), and do not allow use of the deprecated `filter` parameter.\n\n#### Search Examples\n\nFind all active Appointments created or updated since March 15th, 2023 at 8am MST (since created appts also have updated lastChangeDateTime)\n\n```\ns={\"lastChangedDateTime\":{\"$gt\":\"2023-03-15T08:00:00.000-07:00\"}}\n```\n\nFind all soft-deleted (inActive) appointments updated since a date/time (isActive:false indicates soft-deleted)\n\n```\ns={\"$and\":[{\"lastChangedDateTime\": {\"$gt\":\"2023-07-7T00:00:00.000Z\"}},{\"isActive\":false}]}\n```\n\nFind all appointments changed since a date time (both active and inactive).\nThis is useful for integration partners with recurring series who need to know future appointments in the series have been removed\n\n```\ns={\"$and\":[{\"lastChangedDateTime\": {\"$gt\":\"2023-07-7T00:00:00.000Z\"}},{\"$or\":[{\"isActive\":true},{\"isActive\":false}]}]}\n```\n\nFind all Appointment where the `tags` are empty\n\n```\ns={\"tags\": {\"$or\": {\"$isnull\": true, \"$eq\": \"{}\"}}}\n```\n\nFind all Appointments where it includes a tag of `Late`\n\n```\ns={\"tags\":{\"$contL\":\"Late\"}}\n```\n\nFind all appointments in `Scheduled` status set to start after March 15th, 2023 at 8am MST\n\n```\ns={\"$and\":[{\"status\":\"Scheduled\"},{\"start\":{\"$gt\":\"2023-03-15T08:00:00.000-07:00\"}}]}\n```\n\n#### Join examples (with Fields)\n\nTo return data from other tables without the need to make a secondary query, the API consumer can join specific tables\ntogether and request only the fields necessary.\n\nGet the appointment with the carrier and company. This will return a nested `User` with a nested `Company` in the result for\neach appointment.\nOrder matters here. You must first include `user` to get to `user.company`.\n\n```\njoin=user&join=user.company\n```\n\nTo get just the user's email and company's name, you can use the `||` operator.\nBecause `user.companyId = company.id` you must at least include `companyId` on `user`\n\n```\njoin=user||email,companyId&join=user.company||name\n```\n\n#### Other Examples\n\nTo get an appointment's refNumber (PO), start, lastChangedDateTime, and carrier company name\n\n```\ns={\"start\": {\"$gt\":\"2023-03-15T00:00:00.000Z\"}}&join=user||companyId&join=user.company||name&fields=refNumber,lastChangedDateTime,start\n```\n\n---\n"
version: v4.144.0 - 39b4253
contact: {}
servers:
- url: https://neutron.opendock.com
description: Production Server
- url: https://neutron.staging.opendock.com
description: Staging Server
tags:
- name: Users
paths:
/user/invite:
post:
operationId: UserController_invite
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InviteDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
tags:
- Users
security:
- bearer: []
/user/{id}:
get:
operationId: getOneBaseUserControllerUser
summary: Retrieve a single User
parameters:
- name: id
required: true
in: path
schema:
type: string
- name: fields
description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: false
- name: join
description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: true
- name: cache
description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
required: false
in: query
schema:
type: integer
minimum: 0
maximum: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
tags:
- Users
security:
- bearer: []
delete:
operationId: deleteOneBaseUserControllerUser
summary: Delete a single User
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
tags:
- Users
security:
- bearer: []
patch:
operationId: updateOneBaseUserControllerUser
summary: Update a single User
parameters:
- name: id
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
tags:
- Users
security:
- bearer: []
/user:
get:
operationId: getManyBaseUserControllerUser
summary: Retrieve multiple Users
parameters:
- name: fields
description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: false
- name: s
description: Adds search condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#search" target="_blank">Docs</a>
required: false
in: query
schema:
type: string
- name: filter
description: Adds filter condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#filter" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: true
- name: or
description: Adds OR condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#or" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: true
- name: sort
description: Adds sort by field. <a href="https://github.com/nestjsx/crud/wiki/Requests#sort" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: true
- name: join
description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
required: false
in: query
schema:
type: array
items:
type: string
style: form
explode: true
- name: limit
description: Limit amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#limit" target="_blank">Docs</a>
required: false
in: query
schema:
type: integer
- name: offset
description: Offset amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#offset" target="_blank">Docs</a>
required: false
in: query
schema:
type: integer
- name: page
description: Page portion of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#page" target="_blank">Docs</a>
required: false
in: query
schema:
type: integer
- name: cache
description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
required: false
in: query
schema:
type: integer
minimum: 0
maximum: 1
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedDto'
- properties:
entity:
type: string
example: User
data:
type: array
items:
$ref: '#/components/schemas/User'
tags:
- Users
security:
- bearer: []
/user/email-available/{email}:
get:
operationId: UserController_isEmailAvailable
parameters:
- name: email
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: boolean
tags:
- Users
security:
- bearer: []
/user/change-password:
post:
operationId: UserController_changePassword
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChangePasswordDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
tags:
- Users
security:
- bearer: []
/user/accept-tc:
post:
operationId: UserController_acceptTC
parameters: []
responses:
'200':
description: ''
tags:
- Users
security:
- bearer: []
components:
schemas:
User:
type: object
properties:
id:
type: string
description: The unique identifier of the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
createDateTime:
format: date-time
type: string
description: The date and time when the record was created
example: '2023-10-01T12:00:00Z'
readOnly: true
createdBy:
type: object
description: The ID of the user who created the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
lastChangedDateTime:
format: date-time
type: string
description: The date and time when the record was last changed
example: '2023-10-01T12:00:00Z'
readOnly: true
role:
type: string
enum:
- role_owner
- role_admin
- role_operator
- role_attendant
- role_spectator
- role_yard_driver
- role_carrier_admin
- role_carrier
- role_base
appointments:
type: array
items:
$ref: '#/components/schemas/Appointment'
company:
type: Company
orgCarrierSettings:
type: array
items:
type: OrgCarrierSettings
org:
type: Org
warehouseAccessList:
type: UUID
tcConfirmedAt:
format: date-time
type: string
required:
- id
- createDateTime
- createdBy
- lastChangedDateTime
TimeInterval:
type: object
properties:
end:
format: date-time
type: string
start:
format: date-time
type: string
required:
- end
- start
InviteDto:
type: object
properties: {}
CustomFieldTemplateDto:
type: object
properties:
semanticLabelId:
type: object
format: uuid
description: Semantic label id (FK to semanticlabel)
type:
type: string
enum:
- str
- bigstr
- date
- bool
- doc
- multidoc
- int
- email
- phone
- dropdown
- dropdownmultiselect
- combobox
- timestamp
- action
required:
- type
OrgCarrierSettings:
type: object
properties:
id:
type: string
description: The unique identifier of the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
createDateTime:
format: date-time
type: string
description: The date and time when the record was created
example: '2023-10-01T12:00:00Z'
readOnly: true
createdBy:
type: object
description: The ID of the user who created the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
lastChangedDateTime:
format: date-time
type: string
description: The date and time when the record was last changed
example: '2023-10-01T12:00:00Z'
readOnly: true
org:
$ref: '#/components/schemas/Org'
orgId:
type: string
user:
$ref: '#/components/schemas/User'
userId:
type: string
favoriteWarehouseIds:
type: array
items:
type: string
required:
- id
- createDateTime
- createdBy
- lastChangedDateTime
ClockSpan:
type: object
properties:
end:
type: string
example: '18:00'
start:
type: string
example: 06:00
required:
- end
- start
Appointment:
type: object
properties:
id:
type: string
description: The unique identifier of the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
createDateTime:
format: date-time
type: string
description: The date and time when the record was created
example: '2023-10-01T12:00:00Z'
readOnly: true
createdBy:
type: object
description: The ID of the user who created the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
lastChangedDateTime:
format: date-time
type: string
description: The date and time when the record was last changed
example: '2023-10-01T12:00:00Z'
readOnly: true
type:
type: string
enum:
- Standard
- Reserve
status:
type: string
enum:
- NoShow
- Cancelled
- Requested
- Scheduled
- Arrived
- InProgress
- Completed
user:
$ref: '#/components/schemas/User'
userId:
type: object
loadType:
type: LoadType
loadTypeId:
type: string
dock:
type: Dock
org:
type: Org
orgId:
type: string
end:
format: date-time
type: string
eta:
format: date-time
type: string
refNumber:
type: string
refNumbers:
type: array
items:
type: string
customFields:
type: array
items:
type: string
notes:
type: object
ccEmails:
type: array
items:
type: string
recurringParentId:
type: string
recurringParent:
$ref: '#/components/schemas/Appointment'
recurringChildren:
$ref: '#/components/schemas/Appointment'
recurringPattern:
type: object
reschedules:
type: array
items:
type: string
muteNotifications:
type: boolean
isCheckedInByCarrier:
type: boolean
required:
- id
- createDateTime
- createdBy
- lastChangedDateTime
ChangePasswordDto:
type: object
properties: {}
PaginatedDto:
type: object
properties:
count:
type: number
example: 2
total:
type: number
example: 2
page:
type: number
example: 1
pageCount:
type: number
example: 1
action:
type: string
example: read
entity:
type: string
example: Appointment
data:
type: array
items:
type: string
required:
- count
- total
- page
- pageCount
- action
- entity
- data
ScheduleDto:
type: object
properties:
sunday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
monday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
tuesday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
wednesday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
thursday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
friday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
saturday:
type: array
items:
$ref: '#/components/schemas/ClockSpan'
version:
type: number
example: 1
closedIntervals:
type: array
items:
$ref: '#/components/schemas/TimeInterval'
required:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- version
- closedIntervals
UpdateUserDto:
type: object
properties:
tags:
type: object
email:
type: string
firstName:
type: string
lastName:
type: string
phone:
type: string
role:
type: string
enum:
- role_owner
- role_admin
- role_operator
- role_attendant
- role_spectator
- role_yard_driver
- role_carrier_admin
- role_carrier
- role_base
orgCarrierSettings:
type: array
items:
$ref: '#/components/schemas/OrgCarrierSettings'
orgId:
type: string
warehouseAccessList:
type: UUID
Org:
type: object
properties:
id:
type: string
description: The unique identifier of the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
createDateTime:
format: date-time
type: string
description: The date and time when the record was created
example: '2023-10-01T12:00:00Z'
readOnly: true
createdBy:
type: object
description: The ID of the user who created the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
lastChangedDateTime:
format: date-time
type: string
description: The date and time when the record was last changed
example: '2023-10-01T12:00:00Z'
readOnly: true
warehouses:
type: array
items:
$ref: '#/components/schemas/Warehouse'
reportSearches:
type: object
customTags:
type: array
items:
type: string
samlConfig:
type: object
orgType:
type: string
enum:
- Trial
- Test
- Client
expiresAt:
format: date-time
type: string
required:
- id
- createDateTime
- createdBy
- lastChangedDateTime
Warehouse:
type: object
properties:
id:
type: string
description: The unique identifier of the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
createDateTime:
format: date-time
type: string
description: The date and time when the record was created
example: '2023-10-01T12:00:00Z'
readOnly: true
createdBy:
type: object
description: The ID of the user who created the record
example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
readOnly: true
lastChangedDateTime:
format: date-time
type: string
description: The date and time when the record was last changed
example: '2023-10-01T12:00:00Z'
readOnly: true
schedule:
$ref: '#/components/schemas/ScheduleDto'
country:
type: string
timezone:
type: string
docks:
type: Dock
loadTypes:
type: LoadType
org:
type: Warehouse
orgId:
type: string
contactName:
type: string
phone:
type: string
email:
type: string
notes:
type: string
instructions:
type: string
customApptFieldsTemplate:
type: array
items:
$ref: '#/components/schemas/CustomFieldTemplateDto'
refNumberValidationVersion:
type: string
enum:
- V1
- V2
refNumberValidationUrl:
type: string
refNumberValidationPasscode:
type: string
settings:
type: object
allowCarrierScheduling:
type: boolean
geolocation:
type: object
ccEmails:
type: array
items:
type: string
amenities:
type: array
example:
- Lumper services
- Drivers restroom
- Overnight parking
- Free Wi-Fi
items:
type: string
enum:
- Lumper services
- Drivers restroom
- Overnight parking
- Free Wi-Fi
ppeRequirements:
type: array
example:
- Face Mask
- Safety Glasses
- Hard Hat
- Safety Boots
- Gloves
- High Visibility Vest
- Long Pants
- Long Sleeves
- No Smoking
- Hair and Beard Net
items:
type: string
enum:
- Face Mask
- Safety Glasses
- Hard Hat
- Safety Boots
- Gloves
- High Visibility Vest
- Long Pants
- Long Sleeves
- No Smoking
- Hair and Beard Net
intervalTrimForCarriers:
type: number
customBookingUrl:
type: string
required:
- id
- createDateTime
- createdBy
- lastChangedDateTime
- schedule
- amenities
- ppeRequirements
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/loadsmart/refs/heads/main/openapi/loadsmart-users-api-openapi.yml