API reference
Scheduling
Scheduling puts content on screens. Add pictures, videos and HTML5 packages to the content library, then book them on screens, sites or groups for a date range. Bookings can be grouped into campaigns, and each booking can be sent live, retried or ended.
The Booking object
A booking: one file from the content library on some screens for a date range and schedule, with its status, counts and whether it can be sent live, retried or ended.
Attributes
idstring (uuid)RequirednamestringRequiredsourcestringRequiredPossible values
uploadreviewrunmotiondynamicnetworkstatusstringRequiredcampaignobjectRequiredNullableShow child attributesHide child attributes
idstringOptionalnamestringOptional
contentarray of objectsRequiredShow child attributesHide child attributes
idstringOptionalnamestringOptionalkindstringOptionalsha256stringOptionalthumbstringOptionaldurationMsintegerOptionalchecksstringOptional
screensarray of objectsRequiredShow child attributesHide child attributes
idstringOptionalnamestringOptionalsiteobjectOptionalNullableShow child attributesHide child attributes
keystringOptionalnamestringOptional
kindstringOptionalPossible values
singlegroupstatestringOptionalPossible values
pendingdraftlivereplacedfailedendedcantPlaybooleanOptional
startDatestringRequiredendDatestringRequiredscheduleobjectRequiredNullableslotsintegerRequiredcountsobjectRequiredShow child attributesHide child attributes
pendingintegerOptionaldraftintegerOptionalliveintegerOptionalreplacedintegerOptionalfailedintegerOptionalendedintegerOptional
livebooleanRequiredcanGoLivebooleanRequiredcanEndbooleanRequiredcanRetrybooleanRequiredcreatedAtstring (date-time)RequiredcreatedBystringRequiredplaysobjectRequiredNullableWith plays=1, once a play is stored.
linksobjectRequiredMain-app paths of a publish made there:
published, andreviewwhen it came from a review. Empty for content booked here.Show child attributesHide child attributes
publishedstringOptionalreviewstringOptional
customerobjectRequiredNullableWho the booking is for.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
prioritystringRequiredPossible values
paidhousepolicyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
outsideCampaignstringRequiredNullableIn words, why its campaign’s dates or hours keep it from playing, for example
Outside its campaign's hours: won't play until 14 Dec.nullwhen it is inside them, or in no campaign.zonesarray of stringsRequiredThe time zones its screens keep, sorted (for example
Australia/Sydney); its days and hours run on those clocks. Empty before it is made.
Add content
Needs the Screens write permission and an editor. Adds a picture (PNG or JPEG), an MP4 video or an HTML5 package (a .zip) to the organisation’s content library, to book on screens. The body is the file’s bytes, sent with its Content-Type and its name in X-Mestra-File-Name (percent-encoded). An HTML5 package may send its length in milliseconds in X-Mestra-Duration-Ms. Names are unique in the library, in any case: a name already used is 409 name_taken. Mestra screens must be on and connected, and the plan must include scheduling (403 plan_refused).
Headers
X-Mestra-File-NamestringRequiredThe file’s name, percent-encoded. Unique in the library.
X-Mestra-Duration-MsintegerOptionalAn HTML5 package’s length in milliseconds.
Body parameters
The request body is image/png.
Returns
The file was added.
An object with:
idstring (uuid)RequirednamestringRequiredkindstringRequiredPossible values
imagevideohtml5mimestringRequiredsha256stringRequiredsizeinteger (int64)RequiredwidthintegerRequired0 when unknown.
heightintegerRequired0 when unknown.
durationMsintegerRequiredA video’s or package’s length; 0 for a picture.
checksstringRequiredPossible values
noneuploadedBystringRequiredThe user who added it; empty when none.
createdAtstring (date-time)RequiredthumbstringRequiredThe address of a picture’s small preview, or empty.
bookedOnintegerRequiredLive or draft bookings that use it.
Errors
| Status | Code | Meaning |
|---|---|---|
400 | The name is missing or not usable, or the package’s length is not valid. | |
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
409 | name_takenintegration_offapi_off |
|
413 | “body exceeds limit (<n> bytes)”. | |
415 | The file is not a PNG, JPEG, MP4 or HTML5 package. | |
501 | The player is not available on this server. |
List all content
Needs the Screens read permission; any member’s session (a viewer too) will do. The organisation’s content library, newest first. kind narrows it to image, video or html5. next is the after value for the following page, or empty on the last.
Query parameters
kindstringOptionalPossible values
imagevideohtml5afterstring (uuid)OptionalThe
nextof the page before.limitintegerOptionalDefault
50
Returns
The files.
A list of objects, each with:
idstring (uuid)RequirednamestringRequiredkindstringRequiredPossible values
imagevideohtml5mimestringRequiredsha256stringRequiredsizeinteger (int64)RequiredwidthintegerRequired0 when unknown.
heightintegerRequired0 when unknown.
durationMsintegerRequiredA video’s or package’s length; 0 for a picture.
checksstringRequiredPossible values
noneuploadedBystringRequiredThe user who added it; empty when none.
createdAtstring (date-time)RequiredthumbstringRequiredThe address of a picture’s small preview, or empty.
bookedOnintegerRequiredLive or draft bookings that use it.
Errors
| Status | Code | Meaning |
|---|---|---|
400 |
| |
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_key |
|
404 | not_connected |
|
409 | api_offintegration_off |
|
501 | The player is not available on this server. |
Retrieve content
Needs the Screens read permission; any member’s session (a viewer too) will do. One file of the content library.
Path parameters
idstring (uuid)Required
Returns
The file.
An object with:
idstring (uuid)RequirednamestringRequiredkindstringRequiredPossible values
imagevideohtml5mimestringRequiredsha256stringRequiredsizeinteger (int64)RequiredwidthintegerRequired0 when unknown.
heightintegerRequired0 when unknown.
durationMsintegerRequiredA video’s or package’s length; 0 for a picture.
checksstringRequiredPossible values
noneuploadedBystringRequiredThe user who added it; empty when none.
createdAtstring (date-time)RequiredthumbstringRequiredThe address of a picture’s small preview, or empty.
bookedOnintegerRequiredLive or draft bookings that use it.
bookingsarray of objectsRequiredThe draft and live bookings that use the file, newest first.
bookedOnis their number.Show child attributesHide child attributes
idstring (uuid)RequirednamestringRequiredstatestringRequiredPossible values
draftlive
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_key |
|
404 | not_connected | No such file in this organisation, or |
409 | api_offintegration_off |
|
501 | The player is not available on this server. |
Delete content
Needs the Screens write permission and an editor. Removes the file from the library. A booking that already plays it keeps playing it until the booking ends; bookedOn says how many bookings that is.
Path parameters
idstring (uuid)Required
Returns
The file was deleted.
An object with:
deletedbooleanRequiredbookedOnintegerRequired
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | not_connected | No such file in this organisation, or |
409 | api_offintegration_off |
|
501 | The player is not available on this server. |
Create a booking
Needs the Screens write permission and an editor. Books files from the content library on screens, sites and groups for a date range and schedule. One booking is made for each file.
Body parameters
idempotencyKeystring (uuid)RequirednamestringOptionalEmpty takes the file’s name.
campaignstringOptionalA campaign id to put the booking in, or empty for none. An unknown or archived campaign is 409
campaign_gone.contentarray of objectsRequiredShow child attributesHide child attributes
idstring (uuid)RequiredplayLengthSecondsintegerOptional
screensarray of stringsOptionalsitesarray of stringsOptionalSite codes.
groupsarray of stringsOptionalstartDatestring (date)RequiredendDatestring (date)RequiredscheduleobjectOptionalNullableslotsintegerOptionalgoLivebooleanOptionalcustomerstring (uuid)OptionalThe customer it is for, from
listMestraCustomers. Empty for none: a booking in a campaign that has a customer is for it. An unknown customer is 404unknown_customer, an archived one 409customer_archived.prioritystringOptionalpaid(the default), orhousefor content that fills what paid bookings leave in a loop. A house booking needs no customer.Possible values
paidhousescalearray of objectsOptionalWhere Scale to fit is ticked. A place that is the same shape as the file but another size (the check lists it with
scalable: true) is booked only for a tick; the booking records who ticked it and when. A tick on a place the file already fits, or on one of another shape, is refused (cant_play). Needs a signed-in person.Show child attributesHide child attributes
contentstring (uuid)RequiredThe library file’s id, as in
content.framestring (uuid)RequiredThe place: a frame’s id, or the screen’s id for its whole window.
policyobjectOptionalLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
Returns
A repeat of an earlier request: the same bookings.
An object with:
bookingsarray of objectsRequiredShow child attributesHide child attributes
idstring (uuid)RequirednamestringRequiredsourcestringRequiredPossible values
uploadreviewrunmotiondynamicnetworkstatusstringRequiredcampaignobjectRequiredNullableShow child attributesHide child attributes
idstringOptionalnamestringOptional
contentarray of objectsRequiredShow child attributesHide child attributes
idstringOptionalnamestringOptionalkindstringOptionalsha256stringOptionalthumbstringOptionaldurationMsintegerOptionalchecksstringOptional
screensarray of objectsRequiredShow child attributesHide child attributes
idstringOptionalnamestringOptionalsiteobjectOptionalNullableShow child attributesHide child attributes
keystringOptionalnamestringOptional
kindstringOptionalPossible values
singlegroupstatestringOptionalPossible values
pendingdraftlivereplacedfailedendedcantPlaybooleanOptional
startDatestringRequiredendDatestringRequiredscheduleobjectRequiredNullableslotsintegerRequiredcountsobjectRequiredShow child attributesHide child attributes
pendingintegerOptionaldraftintegerOptionalliveintegerOptionalreplacedintegerOptionalfailedintegerOptionalendedintegerOptional
livebooleanRequiredcanGoLivebooleanRequiredcanEndbooleanRequiredcanRetrybooleanRequiredcreatedAtstring (date-time)RequiredcreatedBystringRequiredplaysobjectRequiredNullableWith plays=1, once a play is stored.
linksobjectRequiredMain-app paths of a publish made there:
published, andreviewwhen it came from a review. Empty for content booked here.Show child attributesHide child attributes
publishedstringOptionalreviewstringOptional
customerobjectRequiredNullableWho the booking is for.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
prioritystringRequiredPossible values
paidhousepolicyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
outsideCampaignstringRequiredNullableIn words, why its campaign’s dates or hours keep it from playing, for example
Outside its campaign's hours: won't play until 14 Dec.nullwhen it is inside them, or in no campaign.zonesarray of stringsRequiredThe time zones its screens keep, sorted (for example
Australia/Sydney); its days and hours run on those clocks. Empty before it is made.
Errors
| Status | Code | Meaning |
|---|---|---|
400 | A field is missing or not usable ( | |
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refusedsales_paused |
|
404 | unknown_customernot_connected | No such booking, screen or site in this key’s reach, |
409 | customer_archivedapi_offintegration_offplay_lengthpublish_changedcant_play |
|
List all bookings
Needs the Screens read permission; any member’s session (a viewer too) will do. Every publication to Mestra screens, newest first: bookings made here and publishes from the main app.
Query parameters
beforestringOptionalThe
nextof the previous page.playsstringOptional1for each booking’s plays.Possible values
1statusstringOptionalOnly bookings with this status;
liveis any booking with a live item.Possible values
queuedrunningdonepartialfailedlivecampaignstring (uuid)OptionalOnly bookings in this campaign.
customerstring (uuid)OptionalOnly bookings for this customer.
screenstringOptionalOnly bookings with an item on this screen. A screen outside the key’s reach is 404
unknown_screen.sitestringOptionalOnly bookings with an item on a screen of this site (a site code). An unknown site is 404
unknown_site.
Returns
The bookings.
Returns a list of Booking objects.
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | not_connected | No such booking, screen or site in this key’s reach, or |
409 | api_offintegration_offplay_lengthpublish_changedcant_play |
|
Retrieve a booking
Needs the Screens read permission; any member’s session (a viewer too) will do. One booking.
Path parameters
idstring (uuid)Required
Returns
The booking.
Returns the Booking object.
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | not_connected | No such booking, screen or site in this key’s reach, or |
409 | api_offintegration_offplay_lengthpublish_changedcant_play |
|
Update a booking
Needs the Screens write permission and an editor. Renames a booking made from content, or moves it into a campaign or out of one. customer (a customer id, or null to take the customer off), priority (paid, the default, or house for content that fills what paid bookings leave in a loop; a house booking needs no customer) and policy (the booking’s own caps: sharePct, playsPerHour and playsPerDay) change who it is for and how it takes its place in the loop. In policy, a rule left out stays as it is and null clears it. An unknown customer is 404 unknown_customer; an archived one is 409 customer_archived, though a booking keeps the archived customer it already has.
Path parameters
idstring (uuid)Required
Body parameters
namestringOptionalcampaignstringOptionalcustomerstring (uuid)OptionalNullableThe customer it is for, by id;
nulltakes the customer off. An unknown customer is 404unknown_customer, an archived one 409customer_archived.prioritystringOptionalpaid(the default), orhousefor content that fills what paid bookings leave in a loop. A house booking needs no customer.Possible values
paidhousepolicyobjectOptionalThe booking’s own caps (
sharePct,playsPerHour,playsPerDay). A rule left out stays as it is;nullclears it.Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
Returns
The booking.
Returns the Booking object.
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | unknown_customernot_connected | No such booking, screen or site in this key’s reach, |
409 | customer_archivedapi_offintegration_offplay_lengthpublish_changedcant_play |
|
Start a booking on its screens
Needs the Screens write permission and an editor. Sends the booking’s drafts to the screens.
Path parameters
idstring (uuid)Required
Returns
Accepted: the runner will do it.
An object with:
idstringOptionalsendingintegerOptionalitemsintegerOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refusedsales_paused |
|
404 | not_connected | No such booking, screen or site in this key’s reach, or |
409 | api_offintegration_offplay_lengthpublish_changedcant_play |
|
Start a booking again
Needs the Screens write permission and an editor. Tries a booking’s failed screens again.
Path parameters
idstring (uuid)Required
Returns
Accepted: the runner will do it.
An object with:
idstringOptionalsendingintegerOptionalitemsintegerOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | not_connected | No such booking, screen or site in this key’s reach, or |
409 | api_offintegration_offplay_lengthpublish_changedcant_play |
|
Stop a booking
Needs the Screens write permission and an editor. Takes a booking off every screen it plays on, and answers the takedown that confirms each screen.
Path parameters
idstring (uuid)Required
Returns
The key was already used for this booking. The takedown it made.
Returns the Takedown object.
Errors
| Status | Code | Meaning |
|---|---|---|
400 |
| |
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyscreens_limited |
|
404 | not_connected | No such booking, screen or site in this key’s reach, or |
409 | idempotency_conflictpublication_busyapi_offintegration_off |
|
List all screen campaigns
Needs the Screens read permission; any member’s session (a viewer too) will do. The campaigns that group bookings, with how many bookings each holds.
Query parameters
customerstring (uuid)OptionalOnly the campaigns that are for this customer.
Returns
The campaigns.
An object with:
campaignsarray of objectsRequiredShow child attributesHide child attributes
idstring (uuid)RequirednamestringRequiredstartDatestringRequiredA note,
YYYY-MM-DD, or empty. It gates nothing.endDatestringRequiredA note,
YYYY-MM-DD, or empty.archivedbooleanRequiredbookingsintegerRequiredBookings in the campaign.
liveintegerRequiredThose with a file on a screen now.
customerobjectRequiredNullableWho the campaign is for. Its bookings with no customer of their own are for it.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
policyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectRequiredNullableThe daily window its bookings play in (
nullfor none).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_key |
|
404 | not_connected |
|
409 | api_offintegration_off |
|
Create a screen campaign
Needs the Screens write permission and an editor. A named group of bookings. Its dates are a note and gate nothing.
Body parameters
namestringRequiredstartDatestringOptionalendDatestringOptionalcustomerstring (uuid)OptionalpolicyobjectOptionalLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectOptionalThe daily window its bookings play in; its dates and window keep them from playing outside them.
startandendareHH:MM(empty clears them);daysare mon to sun (empty is every day).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Returns
The campaign.
An object with:
idstring (uuid)RequirednamestringRequiredstartDatestringRequiredA note,
YYYY-MM-DD, or empty. It gates nothing.endDatestringRequiredA note,
YYYY-MM-DD, or empty.archivedbooleanRequiredbookingsintegerRequiredBookings in the campaign.
liveintegerRequiredThose with a file on a screen now.
customerobjectRequiredNullableWho the campaign is for. Its bookings with no customer of their own are for it.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
policyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectRequiredNullableThe daily window its bookings play in (
nullfor none).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | not_connected |
|
409 | name_takenapi_offintegration_off |
|
Retrieve a screen campaign
Needs the Screens read permission; any member’s session (a viewer too) will do. One campaign, archived or not.
Path parameters
idstring (uuid)Required
Returns
The campaign.
An object with:
idstring (uuid)RequirednamestringRequiredstartDatestringRequiredA note,
YYYY-MM-DD, or empty. It gates nothing.endDatestringRequiredA note,
YYYY-MM-DD, or empty.archivedbooleanRequiredbookingsintegerRequiredBookings in the campaign.
liveintegerRequiredThose with a file on a screen now.
customerobjectRequiredNullableWho the campaign is for. Its bookings with no customer of their own are for it.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
policyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectRequiredNullableThe daily window its bookings play in (
nullfor none).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_key |
|
404 | No such campaign. | |
409 | api_offintegration_off |
|
Update a screen campaign
Needs the Screens write permission and an editor. Renames a campaign or changes its dates.
Path parameters
idstring (uuid)Required
Body parameters
namestringOptionalstartDatestringOptionalendDatestringOptionalcustomerstring (uuid)OptionalNullablepolicyobjectOptionalLoop rules; a rule set to null is cleared and one left out is kept.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectOptionalSend only what changes:
startandendareHH:MM(empty clears them);daysare mon to sun (empty is every day).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Returns
The campaign.
An object with:
idstring (uuid)RequirednamestringRequiredstartDatestringRequiredA note,
YYYY-MM-DD, or empty. It gates nothing.endDatestringRequiredA note,
YYYY-MM-DD, or empty.archivedbooleanRequiredbookingsintegerRequiredBookings in the campaign.
liveintegerRequiredThose with a file on a screen now.
customerobjectRequiredNullableWho the campaign is for. Its bookings with no customer of their own are for it.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
policyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectRequiredNullableThe daily window its bookings play in (
nullfor none).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | No such campaign. | |
409 | name_takenapi_offintegration_off |
|
Update a screen campaign to archived
Needs the Screens write permission and an editor. Takes a campaign off the pick-list; its bookings stay in it.
Path parameters
idstring (uuid)Required
Returns
The campaign, archived.
An object with:
idstring (uuid)RequirednamestringRequiredstartDatestringRequiredA note,
YYYY-MM-DD, or empty. It gates nothing.endDatestringRequiredA note,
YYYY-MM-DD, or empty.archivedbooleanRequiredbookingsintegerRequiredBookings in the campaign.
liveintegerRequiredThose with a file on a screen now.
customerobjectRequiredNullableWho the campaign is for. Its bookings with no customer of their own are for it.
Show child attributesHide child attributes
idstring (uuid)OptionalnamestringOptionalcategorystringOptional
policyobjectRequiredLoop rules; a rule that is null or left out is not set.
Show child attributesHide child attributes
sharePctintegerOptionalNullableplaysPerHourintegerOptionalNullableplaysPerDayintegerOptionalNullable
windowobjectRequiredNullableThe daily window its bookings play in (
nullfor none).Show child attributesHide child attributes
startstringOptionalendstringOptionaldaysarray of stringsOptional
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyplan_refused |
|
404 | No such campaign. | |
409 | api_offintegration_off |
|
Update a booking's volume
Needs the Screens write permission and an owner. volume is 0 to 100, or null to play the booking muted. It is heard only at a screen whose sound is on. A key limited to some screens may set it only for a booking that plays on its own screens alone (403 screens_limited).
Path parameters
idstring (uuid)Required
Body parameters
volumeintegerRequiredNullable
Returns
The booking’s volume as it is now.
An object with:
idstringOptionalvolumeintegerOptionalNullable
Errors
| Status | Code | Meaning |
|---|---|---|
400 | A volume that is not 0 to 100 or null (with | |
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | wrong_keyscreens_limited |
|
404 | unknown_bookingnot_connected |
|
409 | api_offintegration_off |
|
413 | “body exceeds limit (<n> bytes)”. | |
501 | The player is not available on this server. |
Retrieve a content preview
Needs the Screens read permission; any member’s session (a viewer too) will do. The small PNG preview of a content picture or video, at the address in its thumb.
Path parameters
idstring (uuid)Required
Returns
The PNG.
Errors
| Status | Code | Meaning |
|---|---|---|
401 | invalid_token | The key is missing, unknown, revoked or expired (code |
403 | “Your role (<role>) can’t <action>.” (the role is below the route’s minimum) or “Choose an organisation first.” (the session has no organisation). | |
404 | not_connected | No such file in this organisation, no preview, or |
409 | api_offintegration_off |
|