BookingDefinition

A BookingDefinition is a collection of one to many Bookings. It can describe several types of bookings:

Single occurrence: A job planned for a one-time execution.
Recurring job: A job, that is recurring and can be described by a recurring pattern, i.e. a weekly or bi-weekly recording at a given time for a given duration.
Multi Job: A job which runs parallel on several devices, i.e. several camera perspectives during a sports match are recorded at once.
Crash: A job, which is used for unplanned recordings that should start as fast as possible.

In VidiCore, a BookingDefinition is represented as a collection. So all VidiCore objects representing VidiControl objects under that BookingDefinition are part of this collection (e.g. items representing chunks belonging to that BookingDefinition). VidiControl will set the metadata V3_CollectionType for Collections in VidiCore at this collection.

Properties

Property	Possible Values	Example	Description	Writeable?
id	string	`VCR-0B`	External ID of the BookingDefinition.	Read only (Created by VidiControl).
vcCollectionId	string	COLLECTION-VX-39	ID of the associated collection in VidiCore.	Read only.
parentVcCollectionId	string	COLLECTION-VX-123	VidiCore-ID of the collection, that is assigned as parent to the collection representing this BookingDefinition (vcCollectionId)	Read and write.
metadata	string (VidiCore Metadata Document)	`"{\"timespan\":[{\"start\":\"-INF\",\"end\":\"\\u002BINF\",\"field\":[{\"name\":\"title\",\"value\":[{\"value\":\"This is the title\"}]}]}"`	Metadata of the associated VidiCore collection.	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.
type	string (“Single”, “Recurring”, “Multi”, “Crash”)	Single	The type of the BookingDefinition.	Read and write.
bookings	Array of Booking objects	See Booking	Booking objects this BookingDefinition is containing.	Read and write.
title	string	Collection Title	Title of the BookingDefinition. `null` if no title is set. Currently, this is only used for VidiControl. No synchronisation with VidiCore is done, so it should be set to the same value as the title in the metadata property.	Read and write. Currently not synchronized with VidiCore (see description).
recurrence	Single Recurrence object	See Recurrence.	Object that defines the recurrence for this BookingDefinition. If set, type should be set to “Recurring”	Read and write

Example JSON Snippet

JSON

  {
    "id": "VCR-AwM",
    "bookings": [
      {
        "id": "VCR-AwM",
        "chunkList": [
          {
            "id": "VCR-RRy",
            "commandList": [
              {
                "id": "VCR-X2RQ",
                "capabilityId": "VCR-0B",
                "poolId": "VCR-2n",
                "deviceId": "VCR-XA",
                "executionTime": "2023-01-05T05:00:23Z",
                "duration": 120,
                "index": 1,
                "executionState": "Error",
                "handling": "WaitForResult",
                "content": "{\"action\":\"Record\"}",
                "commandType": "CapabilityRecorder",
                "inPortId": "VCR-GD",
                "outPortId": "VCR-dl"
              },
              {
                "id": "VCR-7QoZ",
                "capabilityId": "VCR-wl",
                "poolId": null,
                "deviceId": "VCR-0B",
                "executionTime": "2023-01-05T04:59:23Z",
                "duration": 60,
                "index": 0,
                "executionState": "Done",
                "handling": "WaitForResult",
                "content": "{\"action\":\"Switch\"}",
                "commandType": "CapabilityRouter",
                "inPortId": "VCR-GD",
                "outPortId": "VCR-rn"
              }
            ],
            "vcItemId": "ITEM-VX-965",
            "metadata": null,
            "start": "2023-01-05T04:59:23Z",
            "end": "2023-01-05T05:02:23Z",
            "executionState": "Error",
            "title": "test"
          }
        ],
        "start": "2023-01-05T04:57:23Z",
        "end": "2023-01-05T05:04:23Z",
        "metadata": null,
        "bookingDefinitionId": null
      }
    ],
    "vcCollectionId": "COLLECTION-VX-878",
    "metadata": null,
    "start": "2023-01-05T04:57:23Z",
    "end": "2023-01-05T05:04:23Z",
    "title": "Collection Title",
    "type": "Single"
  }