Booking [VCon IG]
A Booking is a single booking as a part of a BookingDefinition. So it represents one of several camera perspectives or one job in a series of recurring jobs.
Please note that there is currently no representation of this element in VidiCore’s data model. But it is planned to associate Bookings with VidiCore ItemSequences.
Bookings are always part of a BookingDefinition. In general there are no operations on single Bookings, so BookingDefinition operations must be used to create, edit, get and delete Bookings.
Properties
Property | Possible Values | Example | Description | Writeable? |
---|---|---|---|---|
id | string | 0B | External ID of the Booking. | Read only (Created by VidiControl). |
vcItemSequenceId | string | SEQUENCE-VX-39 | ID of the associated item sequence in VidiCore. Currently not used. | Read only. |
metadata | string (VidiCore Metadata Document) | Metadata of the associated VidiCore item sequence. | Write only. | |
start | string (DateTime using the universal sortable date/time pattern) | 2023-01-04T16:40:27.67Z |
Currently not used. | Read and write. |
end | string (DateTime using the universal sortable date/time pattern) | 2023-01-04T17:40:27.67Z |
Currently not used. | Read and write. |
chunkList | Array of Chunk objects | See Chunk | Chunk objects this Booking is containing. | Read and write. |
bookingDefinitionId | string | 0B | ID of the BookingDefinition that this Booking is contained in. | Read only. |
Example JSON Snippet
{
"id": "XKy",
"chunkList": [],
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"vcItemSequenceId": "",
"metadata": null,
"bookingDefinitionId": "2Z0a"
}