Pre-check Template URL

<< Click to Display Table of Contents >>

Navigation:  For Developers >

Pre-check Template URL

A Template Pre-check can be used to query an external API to remotely reject a Template from being scheduled.

A common use-case is querying a feed provider to check if there is content to display in a feed, before it is shown on screen, rejecting the feed Template if no content is available.

If set, the Template Pre-check URL will be called immediately prior to the Template being queued for playback. If the Pre-check fails, the Template will be rejected and another scheduled according to the normal rules for Pool Templates.

API responses

The feed provider must provide a HTTP route which returns either of the following responses:

Success response

{

 "scheduleTemplate": true

}

Fail response

{

 "scheduleTemplate": false

}