seatAssignments

Update the end of a seat assignment

Requires the SEAT_ASSIGNMENT.UPDATE permission.

patch/v{version}/seat-assignments/{resourceId}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/seat-assignments/{resourceId}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource to be requested.

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
status'SCHEDULED' | 'ACTIVE' | 'ENDED'

Derived from start_at/end_at at read time: SCHEDULED before start_at, ACTIVE while occupied, ENDED after end_at.

parent_customer_idstring

The ID of the parent customer the seat is held under.

customer_idstring

The ID of the processing-only child customer occupying the seat.

product_item_idstring

The ID of the PER_SEAT product item, i.e. the seat type.

start_atstring date-time
end_atstring date-time nullable

Must be strictly after start_at; a seat occupied for zero time is not an occupancy. Clearing it re-opens the seat.

created_atstring nullable
updated_atstring nullable

Response

OK

object_typestring nullable
idstring nullable
status'SCHEDULED' | 'ACTIVE' | 'ENDED'

Derived from start_at/end_at at read time: SCHEDULED before start_at, ACTIVE while occupied, ENDED after end_at.

parent_customer_idstring

The ID of the parent customer the seat is held under.

customer_idstring

The ID of the processing-only child customer occupying the seat.

product_item_idstring

The ID of the PER_SEAT product item, i.e. the seat type.

start_atstring date-time
end_atstring date-time nullable

Must be strictly after start_at; a seat occupied for zero time is not an occupancy. Clearing it re-opens the seat.

created_atstring nullable
updated_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.