Lodging
Ask
List lodging
GET/v1/teams/{teamId}/lodgingLists lodging records for a team.
Required scopes: lodging:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
query.date | string:dateOptional local date filter in YYYY-MM-DD format. Returns lodging records whose local check-in/check-out date range overlaps this date. |
query.limit | integerMaximum number of records to return. Defaults to 50 and is capped at 200. |
query.cursor | stringCursor returned by page.nextCursor from the previous list response. |
Response 200
data | object[] |
|---|---|
data[].name | stringLodging record display name. |
data[].label | string | nullOptional lodging label displayed above the lodging name. |
data[].sortOrder | integer | nullOptional numeric sort order for ordering lodging records. |
data[].confirmationNumber | stringHotel confirmation number. |
data[].location | objectHotel or lodging location details. |
data[].location.name | stringHotel or lodging location display name. |
data[].location.address | stringStreet address or human-readable lodging location address. |
data[].location.placeId | stringGoogle Places ID when available. |
data[].location.latitude | numberOptional lodging latitude in decimal degrees. |
data[].location.longitude | numberOptional lodging longitude in decimal degrees. |
data[].location.timezone | objectIANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time. |
data[].checkInTime | stringISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
data[].checkOutTime | stringISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
data[].contact | objectPrimary lodging contact. |
data[].contact.name | stringContact person's name. |
data[].contact.title | stringContact person's role or job title. |
data[].contact.phone | stringContact phone number. |
data[].contact.email | string:emailContact email address. |
data[].contact.notes | stringShort notes about this contact. |
data[].contacts | object[]Additional lodging contacts. |
data[].contacts[].name | stringContact person's name. |
data[].contacts[].title | stringContact person's role or job title. |
data[].contacts[].phone | stringContact phone number. |
data[].contacts[].email | string:emailContact email address. |
data[].contacts[].notes | stringShort notes about this contact. |
data[].roomCount | integerExpected number of rooms reserved for this lodging block. |
data[].rooms | object[]Rooming-list entries associated with this lodging record. |
data[].rooms[].id | string:uuidStable room identifier. |
data[].rooms[].roomType | stringRoom type or rooming-list label, such as King, Double Queen, or Bus room. |
data[].rooms[].roomNumber | stringAssigned room number, when known. |
data[].rooms[].bagTag | stringBag tag or luggage label associated with this room. |
data[].rooms[].confirmationNumber | stringRoom-specific confirmation number, when different from the lodging record. |
data[].rooms[].checkInDate | stringRoom-specific check-in date in YYYY-MM-DD format, in the lodging timezone. |
data[].rooms[].eta | stringEstimated room arrival time in HH:mm 24-hour local time. |
data[].rooms[].checkOutDate | stringRoom-specific check-out date in YYYY-MM-DD format, in the lodging timezone. |
data[].rooms[].etd | stringEstimated room departure time in HH:mm 24-hour local time. |
data[].rooms[].occupants | stringNames or notes identifying the people assigned to this room. |
data[].rooms[].notes | stringRoom-specific notes. |
data[].notes | stringGeneral lodging notes. |
data[].sourceMetadata | objectOptional integration metadata retained with the lodging record. |
data[].visibility | objectOptional visibility rules for the lodging record. |
data[].visibility.groupIds | string:uuid[] |
data[].visibility.userIds | string:uuid[] |
data[].id | string:uuid |
data[].orgId | string:uuid |
data[].isDeleted | boolean |
data[].version | integerCurrent lodging aggregate version. |
data[].createdAt | string:date-timeISO 8601 timestamp when the lodging record was created. |
data[].createdBy | stringUser identifier that created the lodging record. |
data[].updatedAt | string:date-timeISO 8601 timestamp when the lodging record was last updated. |
data[].updatedBy | stringUser identifier that last updated the lodging record. |
data[].cursor | integerLatest event-ledger cursor projected into this lodging record. |
page | object |
page.limit | integerMaximum number of records returned in this page. |
page.nextCursor | string | nullCursor to pass as the next request's cursor query parameter, or null when there are no more results. |
meta | object |
meta.cursor | number | nullHighest record cursor represented by this response. |
Create lodging
POST/v1/teams/{teamId}/lodgingAccepts a command to create a lodging record.
Required scopes: lodging:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
namerequired | stringLodging record display name. |
|---|---|
label | string | nullOptional lodging label displayed above the lodging name. |
sortOrder | integer | nullOptional numeric sort order for ordering lodging records. |
confirmationNumber | stringHotel confirmation number. |
locationrequired | objectHotel or lodging location details. |
location.name | stringHotel or lodging location display name. |
location.addressrequired | stringStreet address or human-readable lodging location address. |
location.placeId | stringGoogle Places ID when available. |
location.latitude | numberOptional lodging latitude in decimal degrees. |
location.longitude | numberOptional lodging longitude in decimal degrees. |
location.timezone | objectIANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time. |
checkInTimerequired | stringISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
checkOutTimerequired | stringISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
contact | objectPrimary lodging contact. |
contact.namerequired | stringContact person's name. |
contact.title | stringContact person's role or job title. |
contact.phone | stringContact phone number. |
contact.email | string:emailContact email address. |
contact.notes | stringShort notes about this contact. |
contactsrequired | object[]Additional lodging contacts. |
contacts[].namerequired | stringContact person's name. |
contacts[].title | stringContact person's role or job title. |
contacts[].phone | stringContact phone number. |
contacts[].email | string:emailContact email address. |
contacts[].notes | stringShort notes about this contact. |
roomCount | integerExpected number of rooms reserved for this lodging block. |
roomsrequired | object[]Rooming-list entries associated with this lodging record. |
rooms[].idrequired | string:uuidStable room identifier. |
rooms[].roomTyperequired | stringRoom type or rooming-list label, such as King, Double Queen, or Bus room. |
rooms[].roomNumber | stringAssigned room number, when known. |
rooms[].bagTag | stringBag tag or luggage label associated with this room. |
rooms[].confirmationNumber | stringRoom-specific confirmation number, when different from the lodging record. |
rooms[].checkInDate | stringRoom-specific check-in date in YYYY-MM-DD format, in the lodging timezone. |
rooms[].eta | stringEstimated room arrival time in HH:mm 24-hour local time. |
rooms[].checkOutDate | stringRoom-specific check-out date in YYYY-MM-DD format, in the lodging timezone. |
rooms[].etd | stringEstimated room departure time in HH:mm 24-hour local time. |
rooms[].occupants | stringNames or notes identifying the people assigned to this room. |
rooms[].notes | stringRoom-specific notes. |
notes | stringGeneral lodging notes. |
sourceMetadata | objectOptional integration metadata retained with the lodging record. |
visibility | objectOptional visibility rules for the lodging record. |
visibility.groupIds | string:uuid[] |
visibility.userIds | string:uuid[] |
id | string:uuidOptional caller-supplied lodging ID. RoadOps generates one when omitted. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Retrieve lodging
GET/v1/teams/{teamId}/lodging/{lodgingId}Returns one lodging record by ID.
Required scopes: lodging:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.lodgingIdrequired | string:uuidLodging identifier. |
Response 200
data | object |
|---|---|
data.name | stringLodging record display name. |
data.label | string | nullOptional lodging label displayed above the lodging name. |
data.sortOrder | integer | nullOptional numeric sort order for ordering lodging records. |
data.confirmationNumber | stringHotel confirmation number. |
data.location | objectHotel or lodging location details. |
data.location.name | stringHotel or lodging location display name. |
data.location.address | stringStreet address or human-readable lodging location address. |
data.location.placeId | stringGoogle Places ID when available. |
data.location.latitude | numberOptional lodging latitude in decimal degrees. |
data.location.longitude | numberOptional lodging longitude in decimal degrees. |
data.location.timezone | objectIANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time. |
data.checkInTime | stringISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
data.checkOutTime | stringISO 8601 UTC timestamp for the lodging event. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
data.contact | objectPrimary lodging contact. |
data.contact.name | stringContact person's name. |
data.contact.title | stringContact person's role or job title. |
data.contact.phone | stringContact phone number. |
data.contact.email | string:emailContact email address. |
data.contact.notes | stringShort notes about this contact. |
data.contacts | object[]Additional lodging contacts. |
data.contacts[].name | stringContact person's name. |
data.contacts[].title | stringContact person's role or job title. |
data.contacts[].phone | stringContact phone number. |
data.contacts[].email | string:emailContact email address. |
data.contacts[].notes | stringShort notes about this contact. |
data.roomCount | integerExpected number of rooms reserved for this lodging block. |
data.rooms | object[]Rooming-list entries associated with this lodging record. |
data.rooms[].id | string:uuidStable room identifier. |
data.rooms[].roomType | stringRoom type or rooming-list label, such as King, Double Queen, or Bus room. |
data.rooms[].roomNumber | stringAssigned room number, when known. |
data.rooms[].bagTag | stringBag tag or luggage label associated with this room. |
data.rooms[].confirmationNumber | stringRoom-specific confirmation number, when different from the lodging record. |
data.rooms[].checkInDate | stringRoom-specific check-in date in YYYY-MM-DD format, in the lodging timezone. |
data.rooms[].eta | stringEstimated room arrival time in HH:mm 24-hour local time. |
data.rooms[].checkOutDate | stringRoom-specific check-out date in YYYY-MM-DD format, in the lodging timezone. |
data.rooms[].etd | stringEstimated room departure time in HH:mm 24-hour local time. |
data.rooms[].occupants | stringNames or notes identifying the people assigned to this room. |
data.rooms[].notes | stringRoom-specific notes. |
data.notes | stringGeneral lodging notes. |
data.sourceMetadata | objectOptional integration metadata retained with the lodging record. |
data.visibility | objectOptional visibility rules for the lodging record. |
data.visibility.groupIds | string:uuid[] |
data.visibility.userIds | string:uuid[] |
data.id | string:uuid |
data.orgId | string:uuid |
data.isDeleted | boolean |
data.version | integerCurrent lodging aggregate version. |
data.createdAt | string:date-timeISO 8601 timestamp when the lodging record was created. |
data.createdBy | stringUser identifier that created the lodging record. |
data.updatedAt | string:date-timeISO 8601 timestamp when the lodging record was last updated. |
data.updatedBy | stringUser identifier that last updated the lodging record. |
data.cursor | integerLatest event-ledger cursor projected into this lodging record. |
meta | object |
meta.cursor | integerHighest record cursor represented by this response. |
Update lodging
PATCH/v1/teams/{teamId}/lodging/{lodgingId}Accepts a command to update lodging fields.
Required scopes: lodging:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.lodgingIdrequired | string:uuidLodging identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
updatesrequired | objectLodging fields to update. |
updates.name | stringUpdated lodging display name. |
updates.label | string | nullUpdated lodging label displayed above the lodging name, or null to clear it. |
updates.sortOrder | integer | nullUpdated numeric sort order for ordering lodging records, or null to clear it. |
updates.confirmationNumber | string | nullUpdated hotel confirmation number, or null to clear it. |
updates.location | objectUpdated hotel or lodging location details. |
updates.location.name | stringHotel or lodging location display name. |
updates.location.addressrequired | stringStreet address or human-readable lodging location address. |
updates.location.placeId | stringGoogle Places ID when available. |
updates.location.latitude | numberOptional lodging latitude in decimal degrees. |
updates.location.longitude | numberOptional lodging longitude in decimal degrees. |
updates.location.timezone | objectIANA timezone identifier for the lodging location, such as America/Chicago. RoadOps uses this timezone to display check-in and check-out UTC timestamps in local time. |
updates.checkInTime | stringUpdated ISO 8601 UTC check-in timestamp. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
updates.checkOutTime | stringUpdated ISO 8601 UTC check-out timestamp. Send the timestamp in UTC, typically ending in Z; RoadOps uses location.timezone to display the corresponding local time in the app. |
updates.contact | object | nullUpdated primary lodging contact, or null to clear it. |
updates.contact.name | stringContact person's name. |
updates.contact.title | stringContact person's role or job title. |
updates.contact.phone | stringContact phone number. |
updates.contact.email | string:emailContact email address. |
updates.contact.notes | stringShort notes about this contact. |
updates.contacts | object[]Updated additional lodging contacts. |
updates.contacts[].namerequired | stringContact person's name. |
updates.contacts[].title | stringContact person's role or job title. |
updates.contacts[].phone | stringContact phone number. |
updates.contacts[].email | string:emailContact email address. |
updates.contacts[].notes | stringShort notes about this contact. |
updates.roomCount | integer | nullUpdated expected room count, or null to clear it. |
updates.rooms | object[]Updated rooming-list entries. |
updates.rooms[].idrequired | string:uuidStable room identifier. |
updates.rooms[].roomTyperequired | stringRoom type or rooming-list label, such as King, Double Queen, or Bus room. |
updates.rooms[].roomNumber | stringAssigned room number, when known. |
updates.rooms[].bagTag | stringBag tag or luggage label associated with this room. |
updates.rooms[].confirmationNumber | stringRoom-specific confirmation number, when different from the lodging record. |
updates.rooms[].checkInDate | stringRoom-specific check-in date in YYYY-MM-DD format, in the lodging timezone. |
updates.rooms[].eta | stringEstimated room arrival time in HH:mm 24-hour local time. |
updates.rooms[].checkOutDate | stringRoom-specific check-out date in YYYY-MM-DD format, in the lodging timezone. |
updates.rooms[].etd | stringEstimated room departure time in HH:mm 24-hour local time. |
updates.rooms[].occupants | stringNames or notes identifying the people assigned to this room. |
updates.rooms[].notes | stringRoom-specific notes. |
updates.notes | string | nullUpdated lodging notes, or null to clear them. |
updates.visibility | object | nullUpdated visibility rules, or null to clear them. |
updates.visibility.groupIds | string:uuid[] |
updates.visibility.userIds | string:uuid[] |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Delete lodging
DELETE/v1/teams/{teamId}/lodging/{lodgingId}Accepts a command to delete a lodging record.
Required scopes: lodging:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.lodgingIdrequired | string:uuidLodging identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |