1. Overview
    1. Status
    2. URL
    3. Setup & Onboarding
    4. Response Codes
    5. Date Formats
    6. Security
  2. Authentication & Authorisation
    1. Grant Type
    2. Authentication Operation
  3. Models
    1. Network
    2. Network Status
    3. Network KPI
    4. Player KPI
    5. Player Type
    6. Player Type KPI Setting
    7. Media Asset
    8. Playlist
    9. Playlist Media Asset
    10. Playlist Media Asset Conditions
    11. Validity
    12. Playlist Media Asset Actions
    13. Thumbnail Request
    14. Media Asset Metadata
    15. Tags
    16. Proof of Play Reference
    17. Folder
    18. FolderItem
    19. Layout
    20. Media Window
    21. Player
    22. Site
    23. Bandwidth Usage
    24. Player Type
    25. Player Content Status
    26. Player Screen Status
    27. System Information
    28. Player Networking
    29. Note
    30. Schedule Item
    31. Scheduled Layout
    32. Scheduled Media Window
    33. Scheduled Playlist
    34. Interrupt
    35. Licence Summary
    36. Licence
    37. Licence Renewal Option
    38. Licence Conversion Option
    39. Screen Control Settings
    40. Screen Control Schedule
    41. Global Screen Control
    42. Network User
    43. Player Connection
    44. Player List
    45. Saved Search
    46. Publication
    47. Publish Issue
    48. Publish Result
    49. Player Screenshot
    50. Player Screenshot Settings
    51. Player Screenshot Request
  4. Operations
    1. Network
      1. Get
    2. Status
      1. Get
    3. Network KPI Setting
      1. Get
      2. Update
    4. Player
      1. Get
      2. Get List
      3. Update
      4. Delete
      5. System Information
        1. Get
      6. Networking
        1. Get
        2. Create
        3. Update
        4. Delete
      7. Notes
        1. Get
        2. Create
        3. Update
        4. Delete
      8. Content
        1. Schedules
          1. Get
          2. Delete
          3. Delete All
        2. Interrupts
          1. Get
          2. Update
          3. Delete
        3. Status
          1. Get
      9. Layouts
        1. Get
      10. Media Assets
        1. Get
      11. Licence
        1. Summary
          1. Get
      12. Connections
        1. Get
      13. Tags
        1. Get
        2. Get All
        3. Create
        4. Update
        5. Delete
      14. Screen Control
        1. Settings
          1. Get
          2. Create
          3. Update
          4. Delete
        2. Schedule
          1. Get
          2. Create
          3. Update
          4. Delete
          5. Get the screen on/off status
      15. Screenshots
        1. Get
        2. Request
          1. Post
        3. Settings
          1. Get
          2. Create
          3. Update
      16. Upload log files
      17. Bandwidth
        1. Get
      18. Proof of Play
        1. Get
        2. Create
        3. Update
        4. Delete
    5. Licences
      1. Get
      2. Summary
        1. Get All
        2. Get
      3. Activate
      4. Deactivate
      5. Renew
      6. Convert
      7. Renewals
        1. Get
        2. Options
      8. Conversions
        1. Options
    6. Media Assets
      1. Get All
      2. Get
      3. Create
      4. Upload
      5. Update
      6. Delete
      7. Thumbnails
        1. Request
      8. Metadata
        1. Get
      9. Tags
        1. Get
        2. Create
        3. Update
        4. Delete
      10. Proof of Play
        1. Get
        2. Add
        3. Edit
        4. Delete
    7. Playlists
      1. Get List
      2. Get
      3. Create
      4. Update
      5. Delete
    8. Layouts
      1. Get a list
      2. Get
      3. Create
      4. Update
    9. Folders
      1. Get All
      2. Get
      3. Create
      4. Update
      5. Delete
      6. Items
        1. Get
        2. Add
        3. Delete
      7. Tags
        1. Get
        2. Add
        3. Update
        4. Delete
    10. Trash
      1. Get
      2. Add
      3. Restore
      4. Permanently Delete
    11. Player Types
      1. Get All
      2. Get
    12. Player Type KPI Setting
      1. Get
      2. Create
      3. Update
      4. Delete
    13. Global Settings
      1. Players
        1. Content Check
        2. Health Check
        3. Reboots
        4. Proof of Play
        5. Screen Control
    14. Publish Content
      1. Publish
        1. Check
      2. Player List
        1. Get List
        2. Get
        3. Create
        4. Update
      3. Saved Search
        1. Get All
        2. Get
        3. Create
        4. Update
    15. Users
      1. Get All
      2. Create

1.Overview

The Network API is the main API used by the Signagelive User Interface, and is designed to be a RESTful API.

Using the Network API it is possible to have access to all of the functionality available within the Signagelive User Interface, alongside being able to send and retrieve data from Signagelive.

This means that you can not only retrieve monitoring data about your Signagelive players, but also upload content, create/edit playlists and publish content to your Players without the need for interaction with the Signagelive User Interface.

1.1.API Status

The Network API is only available to Signagelive partners. If you would like to start using the Network API then please fill out our Signup form.

1.2.API URL

https://­networkapi.signagelive.com/

1.3.API Setup & Onboarding

On receipt of a request for access to the Network API Signagelive will perform the initial on-boarding and setup to provide access to the Network API on a per network basis.

Note that a single application can be made available to multiple networks.

1.4.Response Codes

The Signagelive Player API will return standard HTTP response codes, clients are expected to respect the response from the API, particularly relating to bad requests, rate limits etc and not attempt to make the call again until either the issue has been resolved or timeout period has passed.

The following table shows a brief summary of the expected API response codes:

Response Code Description
200 OK Request was fulfilled
201 Created Request was successful and a new document was created
204 No Content The request was successfully processed, but is not returning any content
400 Bad Request The request cannot be fulfilled due to bad syntax
401 Unauthorized The supplied credentials do not have access to the requested resource
403 Forbidden The supplied credentials have been disabled
404 Not Found The resource could not be found
405 Method Not Allowed A request was made to a resource using a request method not supported by that resource
408 Request Timeout The server timed out waiting for the request
409 Conflict The request could not be completed because the request would conflict with data already available on the server
500 Internal Server Error An internal server error occurred when processing the request
501 Not Implemented The server does not recognise the request
503 Service Unavailable The servers are up but currently overloaded with requests

1.5.Date Formats

Date Time values will be expressed using the ISO 8601 format e.g. 2012-12-31T23:59:59Z. Note that some date time values will be in UTC (using the ‘Z’ time zone designator) and some will be in local time.

Time only values will be expressed as a timespan in the form of “HH:MM:SS” e.g. “15:25:00” for 3:25 PM.

1.6.Security

The API currently implements an OAuth authentication and authorization model whereby a Signagelive UI Token generated by the application framework is exchanged for a OAuth token. OAuth services are provided by OWIN middleware.

Authorization is provided by a custom Authorization Attribute that allows user levels to be passed for each Controller or Methods.

In order to ensure the API is as secure as possible the API and callers do not need to change their code the API will continue to only accept an OAuth token when calling API Methods. Embedded into the OAuth Token is the original SLUI Token which will be passed to the Web Service via the existing Web Service Wrapper.

This methodology will mean that we (or third parties) will not need to change authentication models as we update the Network API, as we can change the data embedded as this is obfuscated by encryption to the caller, and also not change the web service security interface used by the existing Flash modules.

2.API Authentication & Authorization

As part of the on-boarding process Signagelive will provide the user with the following credentials, which are required to authenticate with the API:

  1. Network ID
  2. Client ID
  3. Client Secret
  4. Authorization Code
  5. Grant Type

Upon successful authentication, these credentials will be exchanged for an access token, which should be included with each subsequent request in the Authorization header.

2.1.API Grant Type

The grant type will always be authorization_code.

2.2.API Authentication Operation

To authenticate with the Network API a POST request must be made to {API URL}/token. The body of this request should be populated with the credentials supplied by Signagelive in the form of key/value pairs.

If the authentication request is successful the operation will return a 200 response and a JSON object containing the access token and token type to include in the Authorization header for all subsequent API requests.

The authentication operation is defined below:

URL /token
Method POST
Headers None
Sample Request Data grant_type=authorization_code&client_id={client_id}&client_secret
={client_secret}&code={authorization_code}
Sample Response Data
Response Status 200
Notes N/A

Once a token has expired clients will need to re­authenticate with the API using the
authentication operation in order to get a new access token.

3.Models

There are a number of models that can be returned by the Network API

3.1.Network

A network is a Signagelive network.

Field Definitions

Name Description
name The name of the network
networkStatus The Id of the network’s related network status object
kpiSetting The Id of the networks related network KPI setting object

Example

3.2.Network Status

A network’s status is made of a number of network­wide KPIs. The network Status also includes a complete list of players on the network and each player’s individual player KPIs.

Field Definitions

Name Description
connectedPlayers The total number of connected players
connectedPlayersAlert A boolean indicating whether there is currently an active alert for the number of players not connecting to Signagelive
connectedPlayersPercentage The percentage of all players that have connected
connectedPlayersWarning A boolean indicating whether there is currently an active warning for the number of players not connecting to Signagelive
contentAlert A boolean indicating whether there is currently an active alert for the number of players that do not have their latest content
contentWarning A boolean indicating whether there is currently an active warning for the number of players that do not have their latest content
disconnectedPlayers The total number of disconnected players
playersThatHaveNotGotContent The total number of players that have not got their latest content
playersUnableToReportContentStatus The total number of players unable to report their content status back to Signagelive
playersWithContent The total number of players with their latest content
playersWithContentPercentage The percentage of players that have their latest content
totalActiveAndLicencedPlayers The total number of active and licenced players
totalDeactivatedPlayers The total number of deactivated players
totalExpiredPlayers The total number of players with licences that have expired
totalLicencedPlayers The total number of licenced players
totalOutOfServicePlayers The total number of players that are out of service
uniqueConnectionsThisMonth The total number of unique connections this month
uniqueConnectionsThisWeek The total number of unique connections this week
uniqueConnectionsThisYear The total number of unique connections this Year
uniqueConnectionsToday The total number of unique connections today
playerStatuses An array of player statuses (Player KPI)
lastModifiedDate The datetime that the network status was last updated

Example

3.3.Network KPI

Each network has a collection of KPI settings packaged up within the Network KPI Setting object.

These settings are used to define when the various network and player KPIs will switch between “ok”, “warning” and alert states.

Field Definitions

Name Description
network The network Id the Network KPI Settings are for
percentPlayersNotConnectedWarning When the percentage of players connecting to Signagelive is at or below this value a warning will become active for the number of network connections
percentPlayersNotConnectedAlert When the percentage of players connecting to Signagelive is at or below this value an alert will become active for the number of network connections
percentPlayersNotGotContentWarning When the percentage of players without their latest content is at or below this value a warning will become active for the network content status
percentPlayersNotGotContentAlert When the percentage of players without their latest content is at
or below this value an alert will become active for the network content status
missedHealthCheckWarning The number of health checks a player must miss consecutively in order to trigger a warning status for missed health checks. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
missedHealthCheckAlert The number of health checks a player must miss consecutively in order to an alert status for missed health checks. This is the default global setting for all player types that do not have a
specific player type KPI setting defined.
cPUUsageWarning When a player’s CPU usage reaches or exceeds this percentage a warning status will be triggered for high CPU usage. This is the default global setting for all player types that do not have a
specific player type KPI setting defined.
cPUUsageAlert When a player’s CPU usage reaches or exceeds this percentage an alert status will be triggered for high CPU usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
memoryUsageWarning When a player’s memory usage reaches or exceeds this percentage a warning status will be triggered for high memory usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
memoryUsageAlert When a player’s memory usage reaches or exceeds this percentage an alert status will be triggered for high memory usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
diskUsageWarning When a player’s disk usage reaches or exceeds this percentage a
warning status will be triggered for high disk usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
diskUsageAlert When a player’s disk usage reaches or exceeds this percentage
an alert status will be triggered for high disk usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
temperatureWarning When a player’s temperature reaches or exceeds this percentage
a warning status will be triggered for operating at a high temperature. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
temperatureAlert When a player’s temperature reaches or exceeds this percentage
an alert status will be triggered for operating at a high temperature. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
rebootNumberWarning When a player reboots this many times or more within the reboot warning period a warning status will be triggered for an unusual number of reboots.This is the default global setting for all player types that do not have a specific player type KPI setting defined.
rebootWarningPeriod The reboot warning period. This is a number in minutes.
rebootNumberAlert When a player reboots this many times or more within the reboot warning period an alert status will be triggered for an unusual number of reboots.This is the default global setting for all player
types that do not have a specific player type KPI setting defined.
rebootAlertPeriod The reboot alert period. This is a number in minutes.

Example

3.4.Player KPI

A player KPI contains a combination of player data and player KPIs for a given player.

Field Definitions

Name Description
player The id of player
playerType The id of the player type
label A short label or description for the player
lastModifiedDate The datetime that the player configuration was last modified
lastReboot The datetime of the last reboot
lastHealthCheck The datetime of the last health check
lastContentCheck The datetime of the last content check
cpuUsage The current CPU usage
temperatureCelsius The current operating temperature
totalMemoryBytes The total available memory in bytes
usedMemoryBytes The amount of used memory in bytes
memoryUsage The memory usage as a percentage
totalStorageBytes The total disk storage in bytes
availableStorageBytes The available disk storage in bytes
storageUsage The storage usage as a percentage
renewalDate The datetime of the licence renewal date
inService A boolean showing if the player is currently set as in service or out of service</td
isArchived A boolean indicating if the player has been trashed
contentUpdateNotification A boolean indicating if the player can report back whether or not it has its latest content
isActiveAndLicenced A boolean indicating if the player is active and licenced
isConnected A boolean indicating if the player is connecting to Signagelive
hasContent A boolean indicating if the player has its latest content
clientVersion The currently installed client version
hasConnectedToday A boolean indicating if the player has connected today
hasConnectedThisWeek A boolean indicating if the player has connected this week
hasConnectedThisMonth A boolean indicating if the player has connected this month
hasConnectedThisYear A boolean indicating if the player has connected this year
numberOfMissedHealthChecks The number of missed health checks since the last successful health check
numberOfMissedContentChecks The number of missed content checks since the last successful content Check
cpuStatus The player’s CPU status. Possible values are: ok, warning, alert
memoryStatus The player’s memory status. Possible values are: ok, warning,
alert
storageStatus The player’s storage status. Possible values are: ok, warning, alert
temperatureStatus The player’s temperature status. Possible values are: ok, warning, alert
healthCheckStatus The player’s health check status. Possible values are: ok, warning, alert
contentCheckStatus The player’s content check status. Possible values are: ok, warning, alert
status The player’s overall status. Possible values are: ok, warning, alert

Example

3.5.Player Type

Signagelive supports a large number of player types from Samsung Smart Signage players to PC’s. Each player has a player type that distinguishes it from other player types.

Field Definitions

Name Description
name The name of the player type

Example

3.6.Player Type KPI Setting

The Player Type KPI Settings are used to override the default network­wide KPI settings on a player type specific basis.

This is useful for networks that use a variety of different players with different operating conditions. For example, certain player types may be more prone to higher memory usage or run at a higher operating temperature when compared against other player types.

Field Definitions

Name Description
playerType The ID of the player type the KPI settings relate to
network The ID of the network the KPI settings relate to
missedhealthCheckWarning The number of health checks a player must miss consecutively in order to trigger a warning status for missed health checks. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
missedHealthCheckAlert The number of health checks a player must miss consecutively in order to an alert status for missed health checks. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
cPUUsageWarning When a player’s CPU usage reaches or exceeds this percentage a warning status will be triggered for high CPU usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
cPUUsageAlert When a player’s CPU usage reaches or exceeds this percentage an alert status will be triggered for high CPU usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
memoryUsageWarning When a player’s memory usage reaches or exceeds this percentage a warning status will be triggered for high memory usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
memoryUsageAlert When a player’s memory usage reaches or exceeds this percentage an alert status will be triggered for high memory usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
diskUsageWarning When a player’s disk usage reaches or exceeds this percentage a warning status will be triggered for high disk usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
diskUsageAlert When a player’s disk usage reaches or exceeds this percentage an alert status will be triggered for high disk usage. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
temperatureWarning When a player’s temperature reaches or exceeds this percentage a warning status will be triggered for operating at a high temperature. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
temperatureAlert When a player’s temperature reaches or exceeds this percentage an alert status will be triggered for operating at a high temperature. This is the default global setting for all player types that do not have a specific player type KPI setting defined.
rebootNumberWarning When a player reboots this many times or more within the reboot warning period a warning status will be triggered for an unusual number of reboots.This is the default global setting for all player types that do not have a specific player type KPI setting defined.
rebootWarningPeriod The reboot warning period. This is a number in minutes.
rebootNumberAlert When a player reboots this many times or more within the reboot warning period an alert status will be triggered for an unusual number of reboots.This is the default global setting for all player types that do not have a specific player type KPI setting defined.
rebootAlertPeriod The reboot alert period. This is a number in minutes.

Example

3.7.Media Asset

A Media Asset is a media object that plays within Signagelive. Media Assets can be audio, video, images, flash, web pages, external executable, IPTV stream, Capture cards or RSS feeds.

Field Definitions

Name Description
name Original names of the file/ name given to the web page / IPTV Stream
duration Duration of the media asset in seconds, if this is a video
dateCreated The date the media asset was uploaded to the Signagelive Cloud
lastUsed The date this asset was last added to a playlist.
size The size of the asset in bytes if it is a downloadable asset
url If this is a downloadable asset the url to download the file from the Signagelive CloudIf this is a remote asset (e.g. web page, IPTV, MRSS) then this is where the resource can be found e.g. the stream url in the case of IPTV
supported Boolean indicating if this media asset is supported by any of the Sigangelive players.
includeInProofOfPlay Boolean indicating if this asset should be logged by the Proof of Play solution each time it is played
thumbnails The thumbnails object contains properties relating to different thumbnails that Signagelive generates when an asset is uploaded. All assets once processed will have an imageSmall and an imageLarge property referencing jpgs. Video assets will have a videoH264 thumbnail.

If a thumbnail/preview is not available in a particular format (could be it’s not processed yet or is not applicable) then the relevant property will be omitted.
type High level media type, possible values are:

  • audio
  • image
  • video
  • flash
  • stream
  • web
  • rss
  • tvin
  • widget
hash The hash value used to verify the integrity of the media asset if it is a downloadable asset
hashType The type of hash. Values are “CRC32” or “MD5”.

Example

3.8.Playlist

A playlist is a list of media assets (either physical or virtual such as streams, web pages) that play in the order specified. It is possible to add validity periods and recurrence to media assets in a playlist.

Field Definitions

Name Description
name The name given to the playlist
dateCreated The date the playlist was created
lastModified The date the playlist was last updated
thumbnailUrl Url to the thumbnail for the playlist, usually this is the first asset in the playlist.
size Total size of the playlist in bytes. Note this only includes the assets uploaded to the Signagelive Cloud, not any assets referenced by MRSS, as aside anything else they change on a regular basis.
includeInProofOfPlay Boolean indicating if this asset should be logged by the Proof of Play solution each time it is played
mediaAssets Array of PlaylistMediaAsset objects

Example

As you will see in the Playlist API Method descriptions it is possible to load a lightweight playlist with no Playlist Media Assets or deepload the Playlist which will include the Playlist Media Assets and associated objects such as conditional playback and validity instructions.

Playlist Media Assets represent an instance of a Media Asset in a Playlist, however contain additional data such as overridden duration and conditions, see Playlist Media Asset section for a full description of all Playlist Media Asset fields. The lightweight playlist is intended to instances where only playlist names and summary items are required e.g. selection lists

The deep loaded playlist is intended where operations are required to access playlist media assets e.g. displaying the contents of a playlist.

Light weight playlist

Deep loaded playlist

3.9.Playlist Media Asset

A playlist media asset represents an instance of a media asset in a playlist

Field Definitions

Name Description
mediaAsset The media asset object
duration The duration this media asset should play in the playlist, this may override the actual duration of the media asset. If this is 0 then the duration then this implies play to length i.e. the duration of the actual media asset. If this is 0 then the duration then this implies play to length i.e. the duration of the actual media asset
position The position of the asset in the playlist, this is zero based
includeInProofOfPlay Boolean indicating if this asset should be logged by the Proof of Play solution each time it is played
validity Optional validity object. If this is null then the media asset is available to play at all times
conditions Optional conditions, if this is not then there are no conditions associated with the playback of this media asset.

Example

3.10.Playlist Media Asset Conditions

Field Definitions

Name Description
tags Tags used for matching
include Boolean indicating if a match of tags includes (plays) the media asset or excludes it (does not play)

Example

3.11.Validity

Field Definitions

Name Description
start The day and time that the asset is valid from. Values will either be a date/time (ISO 8601) or null.
end The day and time that the asset is valid to. Values will either be a date/time or null.
startTime The time of day that the item can be displayed from.
endTime The time of day that the item can be displayed to.
days The days on which the item is valid. It is an integer representation of binary flags.

64 = Monday
32 = Tuesday
16 = Wednesday
8 = Thursday
4 = Friday
2 = Saturday
1 = Sunday

i.e a value of 6 indicates that the screen control plan is valid Monday and Tuesday.

Where a start and end date are specified, the media asset is to be played between those dates only.

Where a startTime, endTime and days are specified, the asset is only to be played between the times of day and days of the week given. If the endTime is before the startTime the item has been configured to be active overnight.

An asset could have a start and end specified, or a startTime, endTime and days specified, or both.

Example

3.12.Playlist Media Asset Actions

Field Definitions

Name Description
type
  • HTTPGET
  • HTTPPOST [Reserved for future use]
  • HTTPPUT [Reserved for future use]
  • HTTPDELETE [Reserved for future use]
  • WRITETOFILE
url The url to call if any any of the HTTPx action types are used, can be omitted if using WRITETOFILE
filename The filename to write data to. Can be omitted if any of the HTTPx methods are used
data The data to write data to the file specified in the filename property. Can be omitted if any of the HTTPx methods are used. Note that in the future this will be used to store data to be POSTed/PUT on the server by the appropriate HTTPx method.

Example

The following example shows how to specify that a url can be called when a media asset is played:

The following example shows how to specify a file and the data this is written to it when the media asset is played

3.13.Thumbnail Request

Field Definitions

Name Description
assetId Id of the media asset to create a thumbnail at all
timeIndex Position in the media asset to take the screen capture

Example

3.14.Media Asset Metadata

The media asset metadata object contains meta-data

Field Definitions

Name Description
fileSize The size of the file in bytes. This is omitted if this is not a downloadable file type e.g. a web page
duration The duration of the content if this is a video of flash file, otherwise it is omitted
fileType File Extension
width If detected the pixel width of the file, will be omitted if this is not available
height If detected the pixel height of the file, will be omitted if this is not available
bitrate The high level bit rate of the file if it is a video, will be omitted if this is not available
videoCodec The video codec used, will be omitted if this is not available
videoCodecFriendly Friendly name for the video coded, will be omitted if this is not available
videoBitrate Bitrate used to encode the video stream, will be omitted if this is not availabl
audioCodec Audio Codec used, will be omitted if this is not available
audioCodecFriendly Friendly name for the audio codec used, will be omitted if this is not available
audioBitRate Bit rate used to encode the audio stream, will be omitted if this is not available
audioSampleRate
flashVersion Version of Flash this file was created in, will be omitted if this is not available i.e. not a flash file
flashFPS
flashFPS Frame Per Second the Flash Video was created with, will be omitted if this is not available i.e. not a flash file
videoPreviewAvailable Boolean indicating if a video preview is available, will be omitted if this is not available i.e. not a flash file
playToLength

Example

3.15.Tags

Field Definitions

Name Description
tag The string value of the tag

Example

3.16.Proof of Play Reference

Field Definitions

Name Description
value The reference text
item The ID of the object that the reference is for.

Example

3.17.Folder

Field Definitions

Name Description
name The name of the folder
itemCount The number of items in the folder, this cannot be written too, it is updated by the adding/removing items from a folder
type The Object type this folder will contain. This is a required field

Example

3.18.FolderItem

Field Definitions

Name Description
folder The ID of the folder
itemId The ID of the item in the folder.

Example

3.19.Layout

A layout is the design that is going to be displayed on the screen. Each layout has one or more media zones that define where scheduled content will play.

Field Definitions

Name Description
name The layout name
dateCreated The date the layout was created
createdBy The username of the user who created the layout
width Layout width in pixels
height Layout height in pixels
orientation Layout orientation
backgroundImage The ID of the background image media asset, or null if there is none
backgroundColour The background colour of the layout. Colours will be a HTML colour code e.g. “#FFAA11” or “transparent”
customBackgroundImage If a custom background image has been created in the layout designer, this will be the ID of the the CustomBackgroundImage object
mediaWindows A list of media windows in the layout
isInTrash A boolean value indicating whether or not the layout is in the trash
isTemplate A boolean value indicating whether or not the layout is a template layout
isDeployed Is the layout deployed? Note: only returned for a single layout
font The default font in use on the layout
fontSize The default font size
fontColour The default font colour. The colour will be a HTML colour code
fontIsBold A boolean value to indicate whether or not the font is bold
fontIsItalic A boolean value to indicate whether or not the font is italic
fontIsUnderlined A boolean value to indicate whether or not the font is underlined
textAlign The default text alignment. Possible values are:

  • left
  • right
  • center
  • justify
includeInProofOfPlay A boolean value to indicate whether or not the layout is included in proof of play logging
dateModified The last modified date of the layout

Example

3.20.Media Window

A media window is an area on the screen that plays content (images, video etc or text). A media zone will contain a single media asset and or one or more playlists.

A default playlist plays in a media zone when there is nothing else to play.

Field Definitions

Name Description
x The x coordinate of the window within the layout
y The y coordinate of the window within the layout
width Window Width
height Window Height
zIndex Window Z-Index
type Window type. Possible values are:

  • standard
  • ticker
  • staticText
  • staticImage
  • legacyWidget
  • pictureInPicture
  • webBrowserWidget
  • qrCode
  • widget
propertiesCSV A CSV list of properties used to configure the window
layerName The name of the window
includeInProofOfPlay A boolean value indicating whether or not the window is enabled for proof of play
configuredWidgetPreferences A list of widget preferences

Example

3.21.Player

A player refers to a Signagelive player connecting to the Signagelive network.

A client/player is the device that connects to the Signagelive Player API and plays content that has been scheduled in the form of layouts downloaded from the server.

Field Definitions

Name Description Updateable
serialNumber The player serial number No
type The ID of the player type record for the player No
pcClientEdition The edition of the player. This only applies to the PC player and can be:

  • 0 (Display Edition)
  • 1 (Corporate Communications)
  • 2 (Screensaver)
 No
clientVersion Version of the client installed on the player No
clientId Unique ID provided by the hardware No
enabled Boolean value indicating whether or not the player is enabled No
scheduledRebootEnabled Boolean value indicating whether or not the player is set to reboot automatically Yes
isUploadingLogFiles Boolean value indicating whether or not the player should upload its log files to Signagelive.
separateRssSync Boolean value indicating whether or not the player should sync RSS feeds separately to content checks Yes
lastHealthCheck Date/time of the last health check No
lastContentCheck Date/time of the last content check No
lastReboot Date/time of the last reboot No
contentCheckType The type of content check done by the player. This will be one of the following:

  • 0 – Set interval e.g. every 30 minutes
  • 1 – Daily – Player will perform a content check at a set time every day
 Yes
contentCheckFrequency If contentCheckType is set to 0, this will be how frequently the player will perform content checks. Value is in minutes. Yes
contentCheckTime If contentCheckType is set to 1, this will be the time of day that the player will perform a content check. The value will be a string representation of the time e.g “11:44:00”. Yes
healthCheckFrequency The frequency, in minutes, that the player will perform health checks. Yes
diagnosticsUpdateType The type of diagnostics update done by the player. This will be one of the following:

  • 0 – Set interval e.g. every 30 minutes
  • 1 – Daily – Player will perform a diagnostics update at a set time every day
 Yes
diagnosticsUpdateFrequency If diagnosticsUpdateType is set to 0, this will be how frequently the player will perform diagnostics update. Value is in minutes. Yes
diagnosticsUpdateTime If diagnosticsUpdateType is set to 1, this will be the time of day that the player will perform a content check. The value will be a string representation of the time e.g “11:44:00”. Yes
dateActivated The date the licence was activated on the player. No
inService Boolean value indicating whether or not the player is marked as in service. Yes
followUpRequired Boolean value indicating whether or not the player is marked as requiring a follow up. Yes
maintenanceRequired Boolean value indicating whether or not the player is marked as requiring maintenance. Yes
monthlyBandwidthLimit The monthly bandwidth limit for the player, in gigabytes. No
defaultPlaylist The Id of the default playlist published to the player Yes*
defaultPlaylistDeployed Boolean value indicating whether or not the player has successfully downloaded the default playlist No
licence The Id of the player’s licence No
scheduledRebootTime The time of day that the player will reboot. Yes
rebootAtNextContentCheck A boolean value indicating whether or not the player should reboot when it next performs a content check. Yes
proofOfPlayEnabled A boolean value indicating whether or not proof of play has been enabled on the player. Yes
site The location and contact information for the playe Yes
isInTrash A boolean value indicating whether or not the player is in the trash Yes

* This field can only be updated to ‘null’ to remove the default playlist

Example

3.22.Site

Field Definitions

Name Description
name The name assigned to the player or location
addressLine1 The first line of the address
addressLine2 The second line of the address
city Town/City
county County/State
postcode Postcode/Zipcode
country Country
phone Contact phone number
email Email Address
referenceCode1 Reference Code 1
referenceCode2 Reference Code 2
referenceCode3 Reference Code 3
latitude Latitude portion of the location, represented as a decimal
longitude Longitude portion of the location, represented as a decimal
timezone IANA timezone database timezone name
ipAddress The external IP address detected by Signagelive

Example

3.23.Bandwidth Usage

Field Definitions

Name Description
month The month that the bandwidth log applies for
bandwidthUsed Bandwidth used in bytes

Example

3.24.Player Type

Field Definitions

Name Description
name A friendly name given to the player type
commonName A name that is used to identify a player when it connects to Signagelive
supportsFullscreen A boolean value that indicates whether or not the player supports fullscreen content
supportsLayouts A boolean value that indicates whether or not the player supports layouts
supportsWeb A boolean value that indicates whether or not the player supports web content
supportsStream A boolean value that indicates whether or not the player supports stream content
supportsTvIn A boolean value that indicates whether or not the player supports TV-in e.g. HDMI or display port input
supportsPictureInPicture A boolean value that indicates whether or not the player supports picture in picture
supportsFlash A boolean value that indicates whether or not the player supports flash content
supportsExecutable A boolean value that indicates whether or not the player supports executable files
supportsSync A boolean value that indicates whether or not the player supports player synchronisation
supportsInterrupts A boolean value that indicates whether or not the player supports interrupts
supportsMediaRss A boolean value that indicates whether or not the player supports media rss feeds
supportsMediaRssValidity A boolean value that indicates whether or not the player supports validity in media rss feeds
supportsWidgets A boolean value that indicates whether or not the player supports widgets
supportsControlInterrupts A boolean value that indicates whether or not the player supports interrupts in playlists
supportsContentUpdateNotifications A boolean value that indicates whether or not the player is able to provide notifications when content has been successfully downloaded
supportsStoreForwardScheduling A boolean value that indicates whether or not the player supports store and forward scheduling.
supportsScheduledRecurrence A boolean value that indicates whether or not the player supports schedule recurrence
supportsAssetLevelRecurrence A boolean value that indicates whether or not the player supports asset level recurrence
supportsSystemInformationReporting A boolean value that indicates whether or not the player supports the reporting of system diagnostics information
supportsSeparateRssContentUpdate A boolean value that indicates whether or not the player can download RSS feed content separately to content checks
supportsSettingDefaultVideoInput A boolean value that indicates whether or not the player can set the default video input.
supportsScreenControl A boolean value that indicates whether or not the player supports switching the screen on and off
supportsBootupNotifications A boolean value that indicates whether or not the player supports sending bootup notifications to Signagelive
supportsHealthCheckNotifications A boolean value that indicates whether or not the player supports sending health checks to Signagelive
supportsAutomaticPlayerReboots A boolean value that indicates whether or not the player supports automatic reboots
supportsInstantPlayerReboots A boolean value that indicates whether or not the player supports rebooting after a content check
supportsNetworkingConfiguration A boolean value that indicates whether or not the player supports the setting of networking configuration settings
supportsWirelessConfiguration A boolean value that indicates whether or not the player supports the setting of wireless network configuration settings
thumbnailUrl A string value which is a URL to an image which represents the player type.
supportsSSL A boolean value that indicates whether or not the player supports SSL/TLS.
supportsProofOfPlay A boolean value that indicates whether or not the player supports proof of play
endPointType The type of endpoint that the player will connect to. Possible values are:

  • LegacyPlayer
  • VirtualPlayerBridge
  • InstoreScreen
  • PlayerAPI
  • SimpleSMIL
  • FullSMIL
supportedFileTypes A string which contains a CSV list of supported file types
supportedCodecs A string which contains a CSV list of supported codecs

Example

3.25.Player Content Status

Field Definitions

Name Description
Id An integer representing the Id of the player
status A string value representing the status of published content for the player:

  • ContentDeployed – All content has been successfully downloaded by the player
  • FutureContentNotDeployed – The player has its current content but it has yet to download some content that will become active in the future
  • ContentNotDeployed – The player has yet to download the content that it should currently be playing

Example

3.26.Player Screen Status

Field Definitions

Name Description
Id An integer representing the Id of the player
status A string value representing the status of the screen for this player:

  • ScreenOn – The screen is scheduled to be on.
  • ScreenOff – The screen is scheduled to be off

Example

3.27.System Information

Field Definitions

Name Description
name The system name as supplied by the client or determined by the player type
manufacturer The system manufacturer
upTime System uptime in seconds
systemTime The system time at the last diagnostics update
timezone The timezone as reported by the client, specified using the IANA timezone name
operatingSystem The player operating system –

  • name – the operating system name
  • version – the current OS version
memory The current status of the client’s memory

  • totalBytes – Total amount of memory in bytes
  • usedBytes – Amount of used memory in bytes
processor Information about the player’s processor

  • name – The processor name
  • speed – Processor speed in MHz
  • usage – Processor usage in percent
temperatures A list of temperature sensors

  • name – The sensor name
  • temperatureCelsius – Current temperature in celsius
networkAdapters A list of network adapters present on the player

  • type – Network adapter type. Values can be “Ethernet”, “Wifi” or “Mobile”
  • dhcp – A boolean value indicating whether or not the adapter us using DHCP
  • ipv4Address – The IPv4 address for the network adapter
  • subnetMask – the subnet mask for the network adapter
  • defaultGateway – The default gateway for the network adapter
  • dns1 – The primary DNS server
  • dns2 – The secondary DNS server
  • macAddress – The MAC address for the network adapter
applicationSettings A list of name/value pairs of settings set in the application
systemSettings A list of name/value pairs of settings set on the player’s system
installedSoftware A list of installed software on the client

  • name – The name of the software
  • version – The installed version
  • publisher – The publisher of the software
runningProcesses A list of processes currently running on the client

  • name – The name of the process
  • description – A short description provided by the client
  • averageCpuUsage – The average CPU usage in percent
  • averageMemoryUsage – The average memory usage in bytes
  • currentCpuUsage – Current CPU usage in percent
  • currentMemoryUsage – Current memory usage in bytes
monitors A list of monitors attached to the player

  • name – A name given to the monitor
  • positionX – X-Coordinate for the monitor, to identify its position in a multi-monitor setup.
  • positionY – Y-Coordinate for the monitor, to identify its position in a multi-monitor setup.
  • resolutionX – Monitor width in pixels
  • resolutionY – Monitor height in pixels
drives A list of storage devices available on the player

  • name – The name given to the storage device e.g. “C:\”, “Internal Storage”
  • totalBytes – Total size of the storage device in bytes
  • availableBytes – Available space in bytes
  • format – The file format if available e.g. NTFS, FAT32
graphicsControllers A list of graphics controllers available on the player

  • name – The name given to the graphics controller e.g. “Internal Graphics” or “AMD Radeon R9 380”
  • resolutionX – Output resolution of the device in pixels (width)
  • resolutionY – Output resolution of the device in pixels (height)

Example

3.28.Player Networking

Field Definitions

Name Description
dhcp A boolean value indicating whether or not a player should use DHCP to obtain an IP address
ipv4Address The static IP address to use if DHCP is disabled
subnetMask The subnet mask to use if DHCP is disabled
defaultGateway The default gateway to use if DHCP is disabled
dns1 The primary DNS address to use if DHCP is disabled
dns2 The secondary DNS address to use if DHCP is disabled
broadcastAddress The player’s broadcast address
proxyServer The IP address of the proxy to use
type The type of network, “Ethernet” or “Wifi”.
wifiNetworkName The wifi network name if wifi is enabled
wifiPassPhrase The wifi network pass phrase if wifi is enabled
wifiSecurityType The wifi security type if wifi is enabled. Possible values are:

  • open
  • wep
  • wpa_psk
  • wpa2_psk

Example

3.29.Note

Field Definitions

Name Description
text The note text
dateCreated The date/time the note was created
user The email address of the user who created the note. If the note is created automatically, the author will be “System”

Example

3.30.Schedule Item

Field Definitions

Name Description
id The ID of the scheduled layout
name The name of the scheduled layout or playlist
name The name of the scheduled layout or playlist
type The type of schedule. Possible values are:

  • layout playlist
  • playlist
layout The ID of the layout (null if ‘type’ is playlist)
playlist The ID of the playlist (null if ‘type’ is layout)
start The start date/time for the schedule
end The end date/time for the schedule
deployed A boolean value to show whether or not the schedule item has been fully downloaded by the player
recurrence An object defining the recurrence options of this schedule:

  • startTime – The time of day that the schedule item will start playing
  • endTime – The time of day that the schedule will stop playing. If this is before the start time, the schedule will run overnight.
  • days – Recurrence days selections as an integer representation of binary flags where 1 = Sunday and 64 = Saturday
  • validityStart – The date/time that the content will become valid
  • validityEnd – The date/time that the content will expire

Example

3.31.Scheduled Layout

Field Definitions

Name Description
layout The ID of the parent layout
deployed A boolean value indicating whether or not the scheduled layout has been successfully deployed to the player
isActive A boolean value indicating whether or not the scheduled layout is active on the player
isOverridden A boolean value indicating whether or not the scheduled layout has been overridden by another schedule
isFullscreen A boolean value indicating whether or not the scheduled layout is a fullscreen playlist
start The start date/time of the schedule layout
end The end date/time of the schedule layout
dateConfigured The date/time that the schedule layout was configured
dateDeployed The date/time that the schedule layout was deployed to the player
recurrence The ID of the recurrence object, or null if there is none
scheduledMediaWindows A list of scheduled media windows for this scheduled layout

Example

3.32.Scheduled Media Window

Field Definitions

Name Description
mediaWindow The ID of the parent media window within the parent layout
defaultPlaylist The ID of the default playlist, or null if none configured
properties A string value containing any properties to be used within the media window.
scheduledPlaylists A list of any scheduled playlists within this scheduled media window

Example

3.33.Scheduled Playlist

Field Definitions

Name Description
playlist The ID of the parent playlist that is to be played
start The date/time to start playing
end The date/time to stop playing

Example

3.34.Interrupt

Field Definitions

Name Description
name The name of the interrupt.
trigger The trigger that will start the interrupt.

  • type – The type of interrupt. Possible values are:
    • KeyboardEvent
    • MouseEvent
  • configurationParameters – An array of name/value pairs defining configuration parameters for the trigger. A KeyboardEvent will have an ActionKey and a CancelKey.
  • A MouseEvent will have a ClickRegion, which will be a pipe separated list of regions for a mouse click.
    • An example of an ActionKey or CancelKey value is “A”,“B”, “D0”, or “NumPad0”
    • An example of a ClickRegion for a mouse click is “0,0,1920,1080” or “0,0,200,200|1080,0,200,200”. Each set of 4 numbers corresponds to “X,Y, Width, Height”
action
  • instruction – A string containing either the scheduledLayout ID to play, or the location of an external executable on the client player.
  • instructionType – The type of interrupt. Possible values are:
    • ScheduledLayout
    • ExternalExecutable
  • duration – The duration that the interrupt will play for. If set to 0, it will play until the content finishes, or until it is cancelled by the endAction
  • mediaAsset – If the interrupt is a single media asset, this will be the ID of that media asset
  • playlist – If the interrupt is a playlist, this will be the playlist ID
  • layout – If the interrupt is a layout, this will be the layout ID

Example

3.35.Licence Summary

Field Definitions

Name Description
number The licence number of the primary licence. This will be the trial licence if it is a trial or the standard licence for other registered licences. For un-registered licences, the this is the only licence.
serialNumber The serial number of the player that this licence is registered to, or null for an unregistered licence.
siteName The site name of the player that this licence is registered to, or null for an unregistered licence.
player The ID of the player that this licence is registered to, or null for an unregistered licence.
code The licence code of the primary licence
type The licence type of the primary licence. This will be one of:

  • Trial
  • Standard
  • Renewal
edition The edition of the licence. This will be one of:

  • Display
duration The duration of the licence. For a licence that is a converted trial and/or extended with renewal licences, this will be the total duration of all licences. The value is in months
dateAllocated The date the licence was added to the network
dateRegistered The date the licence was first
dateExpires The date the licence expires
isActive A boolean value that indicates if the licence is active or not. If false, the licence can be reused on new hardware.
trialLicence If the licence is a converted trial, this will be the ID of the trial licence
maxNumberOfOutputs The maximum number of outputs (monitors) that the player can display output to
canRenew A boolean value that indicates whether or not the licence can be renewed e.g. there are appropriate renewals on the network. If the licence is a trial, this will indicate that the licence can be converted to a full licence.

Example

3.36.Licence

Field Definitions

Name Description
number The auto generated licence number. This is used for easy identification of the licence
code The licence code of the primary licence
type The licence type of the primary licence. This will be one of:

  • Trial
  • Standard
  • Renewal
edition The edition of the licence. This will be one of:

  • Display
  • Undecided
duration The duration of the licence. For a licence that is a converted trial and/or extended with renewal licences, this will be the total duration of all licences. The value is in months
dateAllocated The date the licence was added to the network
dateRegistered The date the licence was first
dateExpires The date the licence expires
trialLicence If the licence is a converted trial, this will be the ID of the trial licence
maxNumberOfOutputs The maximum number of outputs (monitors) that the player can display output to
isInTrash A boolean value that indicates whether or not the licence has been trashed

Example

3.37.Licence Renewal Option

Field Definitions

Name Description
id The Id of the record. This id is dynamically generated at the point that the options are returned
description Description of the renewal type
value The length of the renewal in months

Example

3.38.Licence Conversion Option

Field Definitions

Name Description
id The Id of the record. This id is dynamically generated at the point that the options are returned
description Description of the conversion option
value The length of the conversion in months

Example

3.39.Screen Control Settings

Field Definitions

Name Description
portName The name for the serial port
baudRate Port Baud rate. Any standard serial port baud rate is supported
dataBits The amount of data bits as an integer
parity Serial port parity setting. Possible values are:

  • even
  • mark
  • none
  • odd
  • space
stopBits The number of stop bits. This can be 1, 1.5 or 2.
onCommand The string representation of the on command.
offCommand The string representation of the off command.
syncCommand The string representation of the sync command.
sendCarriageReturn A boolean value indicating whether or not a carriage return will be sent with the command.
type The type of screen control to use. The value can be one of:

  • RS232
  • MinicomDSVision3000

Example

3.40.Screen Control Schedule

Field Definitions

Name Description
screenOnTime A string representation of the time of day that the screen will turn on
duration The time, in minutes, that the screen will be on
days days selections as an integer representation of binary flags where 1 = Sunday and 64 = Saturday. In this example, 62 means that the schedule will be active Monday – Friday

Example

3.41.Global Screen Control

An object for setting screen control on all players on the network

Field Definitions

Name Description
screenControlSettings A ScreenControlSettings object to apply to all players. Null to use the system default screen control (most players will use this)
screenControlSchedules An array of ScreenControlSchedule objects to apply to all players

Example

3.42.Network User

A Network User is a represents a user account in Signagelive.

Field Definitions

Name Description
emailAddress The user’s email address. This is also their username.
firstName First Name
lastName Last Name
canAddMedia For Local Users, can the add new media to Signagelive?
password For new users, the initial password
role The access level of the user. Values are:

  • superadministrator
  • administrator
  • user
  • messagemanageruser
  • readonly
  • localuser
enabled Boolean indicating if the user account is enabled or not.

Example

3.43.Player Connection

Field Definitions

Name Description
type The type of connection. Allowed values are:

  • Bootup
  • ContentCheck
  • HealthCheck
  • ContentDeployed
time The date/time of the connection

Example

3.44.Player List

A fixed list of players

Field Definitions

Name Description
name The name of the player list
players The ids of the players in the list

Example

3.45.Saved Search

A saved search for players

Field Definitions

Name Description
name The name of the saved search
searchString A string which will be used to search for players

Example

3.46.Publication

Content to be published.

Field Definitions

Name Description
content An object containing the content to publish:

  • defaultPlaylist – The id of the default playlist to publish to the players, or null if not publishing a default playlist.
  • layouts – An array of scheduledLayout objects to publish
  • interrupts – An array of interrupt objects to publish
players An array of integers containing the player ids to publish to.
ignoreWarnings A boolean value indicating whether or not warnings should be ignored when publishing.

Example

3.47.Publish Issue

Represents a problem that the user should know about when publishing content.

Field Definitions

Name Description
issueLevel The level of the ‘issue’ Possible values are:

  • Warning
  • Error
  • Info

An Error means the content cannot be published
issueType The type of issue. Possible values are:

  • Codec
  • FileType
  • MediaType
  • Size
  • PublishType
  • General
  • None
text A message to describe the issue to the user.

Example

3.48.Publish Result

The result of checking the publication against a player

Field Definitions

Name Description
player The id of the player
type The type of result. This can have one of two values:

  • Check – The publication has been checked against the player but not published
  • Publish – The content was published to the player
result The result of the check or publication. This can have one of two values:

  • Success
  • Failure
publishIssues An array of issues found when checking the publication against this player. An error means that the content cannot be published.

Example

3.49.Player Screenshot

An object containing the URL to a player screenshot and details about the screenshot such as the time it was taken.

Field Definitions

Name Description
id ID of the screenshot
player ID of player the screenshot is for
url URL pointing to the original, high-quality screenshot image
smallThumbnailUrl URL pointing to a small thumbnail image of the screenshot
mediumThumbnailUrl URL pointing to a medium thumbnail image of the screenshot
dateTaken The date and time that the screenshot was taken

Example

3.50.Player Screenshot Settings

An object containing the URL to a player screenshot and details about the screenshot such as the time it was taken.

Field Definitions

Name Description
id ID of the screenshot settings record
player ID of the player the screenshot settings record is associated to
enabled True if remote screenshots are enabled for the player and false if they are not
frequency The frequency that the player should upload screenshots in minutes
takeScreenshotAtNextContentCheck If true the player will take a screenshot when it next performs a content check

Example

3.51.Player Screenshot Request

Field Definitions

Name Description
id ID of the request
player The player that the request is for

Example

4.Operations

4.1.Network

4.1.1.Get

Description Get a Network by ID
HTTP Method GET
URL /networks/{network_id}
Request Body None
Normal Response Code 200
Response Body A Network object

4.2.Status

4.2.1.Get

Description Get the Network Status for a Network
HTTP Method GET
URL /networks/{network_id}/NetworkStatus
Request Body None
Normal Response Code 200
Response Body A Network Status Object

4.3.Network KPI Setting

4.3.1.Get

Description Get Network KPI Settings for a Network
HTTP Method GET
URL /networks/{network_id}/NetworkKPISettings
Request Body None
Normal Response Code 200
Response Body A Network KPI Settings Object

4.3.2.Update

Description Update Network KPI Settings for a Network
HTTP Method PUT
URL /networks/{network_id}/NetworkKPISettings/{id}
Request Body Network KPI Settings object with updates
Normal Response Code 200
Response Body Updated Network KPI Settings Object

4.4.Player

4.4.1.Get a Player

Description Gets a player object
HTTP Method GET
Url /players/{id}
Request Body None
Normal Response Code 200
Response Body Player object

4.4.2.Get List

Description Returns a collection of player objects, that can be optionally filtered
HTTP Method GET
Url /players
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
search Term to be used to compare against the player serial number, site fields and tags, if omitted then all assets that are not trashed or deleted are returned string Empty String
addedFrom Returns only players commissioned after this date Date time
addedTo Returns only players commissioned before this date Date time
folderid Folder ID to return the players for. This implies that it is possible to search within a folder int If a folder ID is specified that is not on the user’s network then a Bad Response should be thrown
syncGroupId Sync Group Id to return the players for. int
intrash Boolean indicating if to return players in the trash. If this is true ONLY players in the trash will be returned Boolean false
  • true
  • false
start Starting position in the array of players, if omitted the default is 0 int 0
limit Number of players to return int 50
order Specifies the order to return players string serialno
  • serialno
  • dateadded
Request Body None
Normal Response Code 200
Response Body Array of player objects

4.4.3.Update a player

Description Allows the editable fields of a player to be updated
HTTP Method PUT
Url /players/{id}
Request Body Player object with updates
Normal Response 200
Response Body Player object

4.4.4.Delete a player

Description Puts a player in the trash
HTTP Method DELETE
Url /players/{id}
Request Body None
Normal Response Code 200
Response Body None

4.4.5.System Information

4.4.5.1.Get

Description Gets the systeminformation for a player
HTTP Method GET
Url /players/{id}/systeminformation
Request Body None
Normal Response Code 200
Response Body PlayerSystemInformation object

4.4.6.Networking

4.4.6.1.Get

Description Gets a player networking object for the player
HTTP Method GET
Url /players/{id}/networking
Request Body None
Normal Response Code 200
Response Body The PlayerNetworking object

4.4.6.2.Create

Description Creates a player networking object
HTTP Method POST
Url /players/{id}/networking
Request Body A new PlayerNetworking object
Normal Response Code 201
Response Body The new PlayerNetworking object

4.4.6.3.Update

Description Edits a player networking object
HTTP Method PUT
Url /players/{id}/networking
Request Body A modified PlayerNetworking object
Normal Response Code 200
Response Body The modified PlayerNetworking object

4.4.6.4.Delete

Description Removes the player networking object from a player
HTTP Method DELETE
Url /players/{id}/networking
Request Body None
Normal Response Code 200
Response Body None

4.4.7.Notes

4.4.7.1.Get

Description Gets all support notes for a player
HTTP Method GET
Url /players/{id}/notes
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
addedFrom Returns only notes added after this date Date time
addedTo Returns only notes added before this date Date time
start Starting position in the array of notes, if omitted the default is 0 int 0
limit Number of notes to return int 50
Normal Response Code A list of note objects
Response Body 200

4.4.7.2.Create

Description Creates a new note
HTTP Method POST
Url /players/{id}/notes
Request Body A new note object
Normal Response Code 201
Response Body The created Note

4.4.7.3.Update

Description Edits the specified note
HTTP Method PUT
Url /players/{id}/notes/{noteid}
Request Body A modified note object
Normal Response Code 200
Response Body The updated note object

4.4.7.4.Delete

Description Deletes the specified note
HTTP Method DELETE
Url /players/{id}/notes/{noteid}
Request Body None
Normal Response Code 200
Response Body None

4.4.8.Content

4.4.8.1.Schedules

4.4.8.1.1.Get

Description Gets all scheduled content items for player
HTTP Method GET
Url /players/{id}/content/schedules
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
rangeStart The start date of the range to search for schedule items. Date time 00:00:00 on the current date This will return schedules active at any point after this date.
rangeEnd The end date of the range to search for schedule items. Date time This will return schedules active at any point between the rangeStart and this date
start Starting position in the array of schedule items, if omitted the default is 0 int 0
limit Number of schedule items to return int 50
Request Body None
Normal Response Code 200
Response Body A list of ScheduledItem objects

4.4.8.1.2.Delete

Description Deletes the specified scheduled item
HTTP Method DELETE
Url /players/{id}/content/schedules/{scheduleitemid}
Request Body None
Normal Response Code 200
Response Body None

4.4.8.1.3.Delete All

Description Deletes all scheduled items from the player
HTTP Method DELETE
Url /players/{id}/content/schedules
Request Body None
Normal Response Code 200
Response Body None

4.4.8.2.Interrupts

4.4.8.2.1.Get

Description Gets all interrupts for player
HTTP Method GET
Url /players/{id}/content/interrupts/
Request Body None
Normal Response Code 200
Response Body A list of interrupt objects

4.4.8.2.2.Update

Description Edits an interrupt on the player
HTTP Method PUT
Url /players/{id}/content/interrupts/{interruptid}
Request Body The interrupt object with either the mediaAsset, playlist, or layout fields modified
Normal Response Code 200
Response Body Interrupt object with updates

4.4.8.2.3.Delete

Description Removes the specified interrupt from the player
HTTP Method DELETE
Url /players/{id}/content/interrupts/{interruptid}
Request Body None
Normal Response Code 200
Response Body None

4.4.8.3.Status

4.4.8.3.1.Get

Description Gets the content status for a player
HTTP Method GET
Url /players/{id}/content/status
Request Body None
Normal Response Code 200
Response Body Content status object

4.4.9.Layouts

4.4.9.1.Get

Description Gets a scheduled layout for a player by id
HTTP Method GET
Url /players/{id}/content/layouts/{scheduledlayoutid}
Request Body None
Normal Response Code 200
Response Body A ScheduledLayout object

4.4.10.Media Assets

4.4.10.1.Get

Description Gets a list of all media assets that have been downloaded to the player
HTTP Method GET
Url /players/{id}/mediaassets
Request Body None
Normal Response Code 200
Response Body A list of media asset objects

4.4.11.Licence

4.4.11.1.Summary

4.4.11.1.1.Get

Description Gets a licence summary object for the specified player
HTTP Method GET
Url /players/{id}/licence/summary
Request Body None
Normal Response Code 200
Response Body Licence collection object

4.4.12.Connections

4.4.12.1.Get

Description Gets the list of recorded player connections for the player
HTTP Method GET
Url /players/{id}/connections
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
start The start position for paging 0
limit The amount of player connections to return 100 100 is the maximum value
dateFrom The earliest date to return connections from Amount is still limited to 100
dateTo The latest date to return connections from
Request Body None
Normal Response Code 200
Response Body Array of Player Connections

4.4.13.Tags

4.4.13.1.Get

Description Gets the tags for the specified player
HTTP Method GET
Url /players/{id}/tags
Request Body None
Normal Response Code 200
Response Body Array of Tags

4.4.13.2.Get All

Description Gets a list of all player tags in use on the network
HTTP Method GET
Url /players/tags
Request Body None
Normal Response Code 200
Response Body A list of strings

4.4.13.3.Create

Description Adds the tag to the tag collection for the specified player
HTTP Method POST
Url /players/{id}/tags
Request Body Tag object with no id
Normal Response Code 201
Response Body Tag object with id

4.4.13.4.Update

Description Allows the user to edit the value of the tag
HTTP Method PUT
Url /players/{id}/tags/{id}
Request Body Tag object with modification to the value
Normal Response Code 200
Response Body Tag with update

4.4.13.5.Delete

Description Allows the user to edit the value of the tag
HTTP Method DELETE
Url /players/{id}/tags/{id}
Request Body None
Normal Response Code 200
Response Body None

4.4.14.Screen Control

4.4.14.1.Settings

4.4.14.1.1.Get

Description

Gets the screen control settings for a player. Note that
if nothing is returned, the player will use its own default screen control method.

For PC players this means Windows power saving.
HTTP Method GET
Url /players/{id}/screencontrol/settings
Request Body None
Normal Response Code 201
Response Body A screen control settings object

4.4.14.1.2.Create

Description Creates a new screen control settings object for the player
HTTP Method POST
Url /players/{id}/screencontrol/settings
Request Body A new ScreenControlSettings object with no ID
Normal Response Code 201
Response Body The ScreenControlSettings object now with an ID

4.4.14.1.3.Update

Description Saves changes to the screen control settings object
HTTP Method PUT
Url /players/{id}/screencontrol/settings
Request Body The edited ScreenControlSettings object
Normal Response Code 200
Response Body The ScreenControlSettings object with the updates

4.4.14.1.4.Delete

Description Removes screen control settings from a player
HTTP Method DELETE
Url /players/{id}/screencontrol/settings
Request Body None
Normal Response Code None
Response Body None

4.4.14.2.Schedule

4.4.14.2.1.Get

Description Gets the ScreenControlSchedules for this player
HTTP Method GET
Url /players/{id}/screencontrol/schedules
Request Body None
Normal Response Code 200
Response Body An array of ScreenControlSchedule objects

4.4.14.2.2.Create

Description Creates a new screen control schedule object for the player
HTTP Method POST
Url /players/{id}/screencontrol/schedules
Request Body new ScreenControlSchedule object with no ID
Normal Response Code 201
Response Body All ScreenControlSchedules for the player

4.4.14.2.3.Update

Description Updates a screen control schedule object for the player
HTTP Method PUT
Url /players/{id}/screencontrol/schedules/{id}
Request Body The updated ScreenControlSchedule object
Normal Response Code 200
Response Body The updated ScreenControlSchedules object

4.4.14.2.4.Delete

Description Removes a screen control schedule object from the player
HTTP Method DELETE
Url /players/{id}/screencontrol/schedules/{scheduleid}
Request Body None
Normal Response Code 200
Response Body None

4.4.14.2.5.Get the screen on/off status

Description Gets the status of the screen for a player
HTTP Method GET
Url /player/{id}/screencontrol/status
Request Body None
Normal Response Code 200
Response Body PlayerScreenStatus object

4.4.15.Screenshots

4.4.15.1.Get

Description Gets all available screenshots for a player
HTTP Method GET
Url /player/{id}/screenshots
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
takenFrom Returns only screenshots taken after this date Date time
takenTo Returns only screenshots taken before this date Date time
start Starting position in the array of notes, if omitted the default is 0 int 0
limit Number of notes to return int 50
Request Body None
Normal Response Code 200
Response Body An array of available screenshots

4.4.15.2.Request

4.4.15.2.1.Post

Description Request that the player takes a screenshot at the next content check
HTTP Method POST
Url /player/{id}/screenshots/request
Request Body A PlayerScreenshotRequest containing the id of the player
Normal Response Code 204
Response Body None

4.4.15.3.Settings

4.4.15.3.1.Get

Description Get screenshot settings for a player
HTTP Method GET
Url /player/{id}/screenshots/settings
Request Body None
Normal Response Code 200
Response Body The player’s screenshot configuration

4.4.15.3.2.Create

Description Creates screenshot settings for a player
HTTP Method POST
Url /player/{id}/screenshots/settings
Request Body The new screenshot settings with no ID
Normal Response Code 200
Response Body The created screenshot settings with generatedID

4.4.15.3.3.Update

Description Updates the screenshot settings for a player
HTTP Method PUT
Url /player/{id}/screenshots/settings
Request Body The edited screenshot settings
Normal Response Code 200
Response Body The updated screenshot settings

4.4.16.Upload log files

Description Sets the player to upload log files
HTTP Method PUT
Url /players/{id}/uploadlogfiles
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
cancelUpload If we want to cancel the upload of log files, we set this to true boolean false
Request Body None
Normal Response Code 200
Response Body None

4.4.17.Bandwidth

4.4.17.1.Get

Description Gets bandwidth used this month by the player
HTTP Method GET
Url /players/{id}/bandwidth
Request Body None
Normal Response Code 200
Response Body A BandwidthUsage object

4.4.18.Proof of Play

Note that calls to Proof of Play will return ‘Unauthorized’ if Proof of Play is not enabled on your network.

4.4.18.1.Get

Description Gets the PoP reference or the specified player
HTTP Method GET
Url /players/{id}/proofofplay/references
Request Body None
Normal Response Code 200
Response Body Array of Proof of Play References for the player

4.4.18.2.Create

Description Adds the reference to the PoP reference collection for the specified player
HTTP Method POST
Url /players/{id}/proofofplay/references
Request Body Proof of Play reference with no ID
Normal Response Code 201
Response Body Proof of Play reference with the new ID

4.4.18.3.Update

Description Allows the user to edit the value of the proof of play reference
HTTP Method PUT
Url /players/{id}/proofofplay/references/{id}
Request Body Proof of Play reference with modification to the value
Normal Response Code 200
Response Body Proof of Play reference with update

4.4.18.4.Delete

Description Allows the user to delete the Proof of Play reference
HTTP Method DELETE
Url /players/{id}/proofofplay/references/{id}
Request Body None
Normal Response Code 200
Response Body None

4.5.Licences

4.5.1.Get

Description Gets a licence object
HTTP Method GET
Url /licences/{id}
Request Body None
Normal Response Code 200
Response Body Licence object

4.5.2.Summary

4.5.2.1.Get All

Description Gets a collection of licence summary objects for the specified network.
HTTP Method GET
Url /licences/summary
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
search Term to be used to compare against the player name, site name, licence code or serial number. If omitted then all licences that are not trashed or deleted are returned string
type The type of licence. Date time Any type
  • Standard
  • Trial
inUse Whether or not a licence has been registered or used as a renewal. boolean Both registered and unregistered licences are returned
  • true
  • false
maxOutputs Maximum number of outputs for a player using this licence. integer Any integer equal to or greater than 0
inTrash Whether or not a licence is in the trash. boolean Only licences not in the trash are returned
  • true
  • false
start Starting position in the array of licence summaries, if omitted the default is 0 int 0
limit Number of licence summaries to return int 50
status The licence status. string All
  • All
  • Active
  • Activateable
  • Unregistered
  • Deactivated
  • Expired
  • ExpireToday
  • Expire7
  • Expire30
  • Expire60
sort The sort order for the licences string
  • expiryDate
sortDirection The sort direction, Ascending (asc) or Descending (desc) string
  • asc
  • desc
Request Body None
Normal Response Code 200
Response Body A collection of Licence summary objects

4.5.2.2.Get

Description Gets a licence summary object for the specified licence
HTTP Method GET
Url /licences/{id}/summary
Request Body None
Normal Response Code 200
Response Body Licence summary object

4.5.3.Activate

Description Activates a licence using the provided activation code
HTTP Method PUT
Url /licences/{id}/activate
Required Parameters
Name Description Data Type Response if omitted Permitted Values
activationCode The 6 digit activation code shown on the client string 400 – Bad Request A 6 character hexadecimal string.
Request Body None
Normal Response Code 204
Response Body

4.5.4.Deactivate

Description Deactivates the licence
HTTP Method PUT
Url /licences/{id}/deactivate
Request Body None
Normal Response Code 204
Response Body

4.5.5.Renew

Description Renews a licence
HTTP Method PUT
Url /licences/{id}/renew?renewalLength={renewalLength}
Required Parameters
Name Description Data Type Response if omitted Permitted Values
renewalLength The length to renew the licence by, in months int 400
Request Body None
Normal Response Code 200
Response Body The updated licence collection object

4.5.6.Convert

Description Converts a licence
HTTP Method PUT
Url /licences/{id}/convert?conversionLength={conversionLength}
Required Parameters
Name Description Data Type Response if omitted Permitted Values
conversionLength The length of licence, in months, to use to convert the trial licence int 400
Request Body None
Normal Response Code 200
Response Body The updated licence collection object

4.5.7.Renewals

4.5.7.1.Get

Description Gets the renewal licences that have been applied to the licence
HTTP Method GET
Url /licences/{id}/renewals
Request Body None
Normal Response Code 200
Response Body A list of licence objects

4.5.7.2.Options

Description Gets the renewal options for the licence
HTTP Method GET
Url /licences/{id}/renewals/options
Request Body None
Normal Response Code 200
Response Body A list of licence renewal option objects

4.5.8.Conversions

4.5.8.1.Options

Description Gets the conversion options for the trial licence
HTTP Method GET
Url /licences/{id}/conversion/options
Request Body None
Normal Response Code 200
Response Body A list of licence conversion option objects

4.6.Media Assets

4.6.1.Get All

Description Returns a collection of media asset objects, that can be optionally filtered
HTTP Method GET
Url /mediaassets
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
search Term to be used to compare against the asset name and tags, if omitted then all assets that are not trashed or deleted are returned string Empty String
addedFrom Returns only assets added after this date Date time
addedTo Returns only assets added before this date Date time
usedFrom Returns only assets used after this date Date time
usedTo Returns only assets used up to this date Date time
types CSV of media types e.g. image,video string audio, image, video, flash, stream, web, rss, tvin, widget A csv containing any of the following values:

  • audio
  • image
  • video
  • flash
  • stream
  • web
  • rss
  • tvin
  • widget
folderid Folder ID to return the assets for. This implies that it is possible to search within a folder int If a folder ID is specified that is not on the user’s network then a Bad Response should be thrown
intrash Boolean indicating if to return asset in the trash. If this is true ONLY assets in the trash will be returned Boolean false
  • true
  • false
start Starting position in the array of media assets, if omitted the default is 0 int 0
limit Number of media assets to return, int 50
providers CSV of third party providers and will limits the media assets returned to the specified providers string Empty String screenfeed
order Specifies the order to return media assets options are returned string alphanumeric
  • alphanumeric
  • datecreated
  • lastused
  • lastModified
Request Body None
Normal Response Code 200
Response Body Array of Media Asset objects

4.6.2.Get

Description Gets a single media asset object
HTTP Method GET
Url /mediaassets/{id}
Request Body None
Normal Response Code 200
Response Body Media Asset object

4.6.3.Create

Description Creates a new media asset where a file upload is not required i.e. adds a web page, IPTV Stream or RSS/MRSS Feed
HTTP Method POST
Url /mediaassets
Request Body
Normal Response Code 201
Response Body Media Asset object

4.6.4.Upload

Description Creates a new media asset where a file upload is required
HTTP Method POST
Url /mediaassets/upload
Request Body The file should be included in the request as Multi Part Form Data
Normal Response Code 201
Response Body Media Asset object

4.6.5.Update

Description Allows the name of the media asset or if it is included in Proof of Play to be updated.
HTTP Method PUT
Url /mediaassets/{id}
Request Body Media Asset object with updates – note that only the name and PoP is updatable
Normal Response Code 200
Response Body Media Asset object

4.6.6.Delete

Description Moves the specified media asset to the trash
HTTP Method DELETE
Url /mediaassets/{id}
Request Body None
Normal Response Code 200
Response Body None

4.6.7.Thumbnails

4.6.7.1.Request

Description Requests a new thumbnail for the specified media asset
HTTP Method POST
Url /mediaassets/{id}/thumbnailrequests
Request Body Thumbnail Request object with no id
Normal Response Code 201
Response Body Thumbnail Request Object with the generated Id

4.6.8.Metadata

4.6.8.1.Get

Description Gets the metadata for the specified media asset
HTTP Method GET
Url /mediaassets/{id}/metadata
Request Body None
Normal Response Code 200
Response Body Media Asset Metadata object

4.6.9.Tags

4.6.9.1.Get

Description Gets the tags for the specified media asset
HTTP Method GET
Url /mediaassets/{id}/tags
Request Body None
Normal Response Code 200
Response Body Array of Tags

4.6.9.2.Create

Description Adds the tag to the tag collection for the specified media asset
HTTP Method POST
Url /mediaassets/{id}/tags
Request Body Tag object with no id
Normal Response Code 201
Response Body Tag object with id

4.6.9.3.Update

Description Allows the user to edit the value of the tag
HTTP Method PUT
Url /mediaassets/{id}/tags/{id}
Request Body Tag object with modification to the value
Normal Response Code 200
Response Body Tag with update

4.6.9.4.Delete

Description Allows the user to edit the value of the tag
HTTP Method DELETE
Url /mediaassets/{id}/tags/{id}
Request Body None
Normal Response Code 200
Response Body None

4.6.10.Proof of Play

Note that calls to Proof of Play will return ‘Unauthorized’ if Proof of Play is not enabled on your network.

4.6.10.1.Get

Description Gets the PoP reference or the specified media asset
HTTP Method GET
Url /mediaassets/{id}/proofofplay/references
Request Body None
Normal Response Code 200
Response Body Array of Proof of Play References for the media asset

4.6.10.2.Add

Description Adds the reference to the PoP reference collection for the specified media asset
HTTP Method POST
Url /mediaassets/{id}/proofofplay/references
Request Body Proof of Play reference with no ID
Normal Response Code 201
Response Body Proof of Play reference with the new ID

4.6.10.3.Edit

Description Allows the user to edit the value of the proof of play reference
HTTP Method PUT
Url /mediaassets/{id}/proofofplay/references/{id}
Request Body Proof of Play reference with modification to the value
Normal Response Code 200
Response Body Proof of Play reference with update

4.6.10.4.Delete

Description Allows the user to delete the Proof of Play reference
HTTP Method DELETE
Url /mediaassets/{id}/proofofplay/references/{id}
Request Body None
Normal Response Code 200
Response Body None

4.7.Playlists

4.7.1.Get List

Description Gets a list of playlists
HTTP Method GET
Url /playlists
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
search Term to be used to compare against the name and tags, if omitted then all playlists that are not trashed or deleted are returned string Empty String
addedFrom Returns only playlists added after this date Date time
addedTo Returns only playlists added before this date Date time
usedFrom Returns only playlists used after this date Date time
usedTo Returns only playlists used up to this date Date time
modifiedFrom Return only playlists last modified after this date
modifiedTo Return only playlists last modified before this date
folderid Folder ID to return the playlists for. int If a folder ID is specified that is not on the user’s network then a Bad Response should be thrown
intrash Boolean indicating if to return playlists in the trash. If this is true ONLY playlists in the trash will be returned Boolean false
  • true
  • false
start Starting position in the array of playlists, if omitted the default is 0 int 0
limit Number of playlists to return, int 50
order Specifies the order to return playlists options are returned String alphanumeric
  • alphanumeric
  • datecreated
  • Lastused
  • modified
deepload Indicates if the Playlist Media Assets and child objects should be loaded.
Only works when getting all assets i.e. not a folder or not trash		 Boolean false
  • true
  • false
Request Body None
Normal Response Code 200
Response Body List of playlist objects

4.7.2.Get

Description Gets a specific playlist
HTTP Method GET
Url /playlists/{id}
Request Body None
Normal Response Code 200
Response Body Playlist Model

4.7.3.Create

Description Creates a playlist
HTTP Method POST
Url /playlists
Request Body Playlist Object with no ID
Normal Response Code 201
Response Body Playlist Model with Id and ID’s for all PlaylistMediaAssets and associated objects

4.7.4.Update

Description Updates the Playlist
HTTP Method PUT
Url /playlists/{id}
Request Body Playlist Model
Normal Response Code 200
Response Body Playlist Model

4.7.5.Delete

Description Deletes the Playlist (moves it to the trash)
HTTP Method DELETE
Url /playlists/{id}
Request Body None
Normal Response Code 200
Response Body None

4.8.Layouts

4.8.1.Get a list

Description Gets a list of layouts on the current network
HTTP Method GET
Url /layouts/
Request Body None
Normal Response Code 200
Response Body A list of layouts

4.8.2.Get

Description Gets a layout
HTTP Method GET
Url /layouts/{id}
Request Body None
Normal Response Code 200
Response Body The Layout object

4.8.3.Create

Description Create a layout
HTTP Method POST
Url /layouts/{id}
Request Body A new layout object with no ID
Normal Response Code 200
Response Body A layout object with and ID and IDs for all media windows and sub objects

4.8.4.Update

Description Edits a layout
HTTP Method PUT
Url /layouts/{id}
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
autoUpdate boolean false true
Request Body The layout object with changes
Normal Response Code 200
Response Body The updated layout object

4.9.Folders

4.9.1.Get All

Description Gets a list of folders
HTTP Method GET
Url /folders
Required Parameters
Name Description Data Type Response if omitted Permitted Values
type Folders are generic objects in the Signagelive system, so the type of folder must be specified that is appropriate to the view string 400 – Bad Request
start Starting position in the array of folders, if omitted the default is 0 int 0
limit Number of folders to return, int 50
Request Body None
Normal Response Code 200
Response Body List of folders objects

4.9.2.Get

Description Gets the specified folder
HTTP Method GET
Url /folders/{id}
Request Body None
Normal Response Code 200
Response Body Folder model

4.9.3.Create

Description Creates a new folder
HTTP Method POST
Url /folders
Request Body Folder model with no id
Normal Response Code 201
Response Body Folder model with Id

4.9.4.Update

Description Updates the specified folder
HTTP Method PUT
Url /folders/{id}
Request Body Folder model – note only the name is updateable
Normal Response Code 200
Response Body Folder model with updates

4.9.5.Delete

Description Deletes the specified folder
HTTP Method DELETE
Url /folders/{id}
Request Body None
Normal Response Code 200
Response Body None

4.9.6.Items

4.9.6.1.Get

Description Get a list of items in a folder.
HTTP Method GET
Url /folders/{id}/items
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
search Term to be used to compare against the item name and tags, if omitted then all items that are not trashed or deleted are returned string Empty String
addedFrom Returns only items added after this date Date time
addedTo Returns only items added before this date Date time
usedFrom Returns only items used after this date Date time
usedTo Returns only items used up to this date Date time
types CSV of types string audio, image, video, flash, stream, web, rss, tvin, widget A CSV containing any the required values
start Starting position in the array of items, if omitted the default is 0 int 0
limit Number of items to return, int 50
providers CSV of third party providers and will limits the media assets returned to the specified providers string Empty String
  • screenfeed
order Specifies the order to return items options are returned string alphanumeric
  • alphanumeric
  • datecreated
  • lastused
  • lastModified
Request Body
Normal Response Code 200
Response Body A list of items within the folder

4.9.6.2.Add

Description Adds an item to a folder. The server will check the folder and the item are the same type.
HTTP Method POST
Url /folders/{id}/items
Request Body Item to add to folder
Normal Response Code 200
Response Body None

4.9.6.3.Delete

Description Removes an item from a folder.
HTTP Method DELETE
Url /folders/{id}/items/{id}
Request Body None
Normal Response Code 200
Response Body None

4.9.7.Tags

4.9.7.1.Get

Description Gets the tags for the specified folder
HTTP Method GET
Url /folders/{id}/tags
Request Body None
Normal Response Code 200
Response Body List of Tag models

4.9.7.2.Add

Description Adds a tag to a folder and subsequently the object in it
HTTP Method POST
Url /folders/{id}/tags
Request Body Tag model with no Id
Normal Response Code 201
Response Body New Tag model with new Id

4.9.7.3.Update

Description Edits a tag to a folder and subsequently the object in it
HTTP Method PUT
Url /folders/{id}/tags/{id}
Request Body Tag model with updates
Normal Response Code 200
Response Body Tag model with edits

4.9.7.4.Delete

Description Deletes a tag from a folder and subsequently the object in it
HTTP Method DELETE
Url /folders/{id}/tags/{id}
Request Body None
Normal Response Code 200
Response Body None

4.10.Trash

4.10.1.Get

Description Lists the objects specified in the trash
HTTP Method GET
Url /{objectname}/trash – Note options are mediaassets, playlists, players
Request Body None
Normal Response Code 200
Response Body List of specified objects

4.10.2.Add

Description Adds the specified object to the trash
HTTP Method PUT
Url /{objectname}/trash – Note options are mediaassets, playlists, players
Request Body Object to put in trash
Normal Response Code 200
Response Body Object passed

4.10.3.Restore

Description Restores the object specified to the library
HTTP Method PUT
Url /{objectname}/trash/{id}/restore – Note options are mediaassets, playlists, players
Request Body None
Normal Response Code 200
Response Body None

4.10.4.Permanently Delete

Description Permanently deletes the object so that it is not available for use in Signagelive
HTTP Method DELETE
Url /{objectname}/trash/{id} – Note options are mediaassets, playlists, players
Request Body None
Normal Response Code 200
Response Body None

4.11.Player Types

4.11.1.Get All

Description Gets a list of all available player types
HTTP Method GET
Url /playertypes
Request Body None
Normal Response Code 200
Response Body List of playertype objects

4.11.2.Get

Description Gets the specified player type
HTTP Method GET
Url /playertypes/{id}
Request Body None
Normal Response Code 200
Response Body A playertype object

4.12.Player Type KPI Setting

4.12.1.Get

Get All Player Type KPI Settings

Description Get All Player Type KPI Settings for a Network
HTTP Method GET
URL /networks/{network_id}/PlayerTypeKPISettings
Request Body None
Normal Response Code 200
Response Body Array of player type kpi settings objects

4.12.2.Create

Create Player Type KPI Setting

Description Create a new Player Type KPI Setting
HTTP Method POST
URL /networks/{network_id}/PlayerTypeKPISettings
Request Body A new Player Type KPI Setting object
Normal Response Code 201
Response Body none

4.12.3.Update

Update Player Type KPI Setting

Description Update an existing Player Type KPI Setting by Id
HTTP Method PUT
URL /networks/{network_id}/PlayerTypeKPISettings/{id}
Request Body Updated Player Type KPI Settings Object
Normal Response Code 200
Response Body A Player Type KPI Settings object

4.12.4.Delete

Delete Player Type KPI Setting

Description Delete a Player Type KPI Setting by Id
HTTP Method DELETE
URL /networks/{network_id}/PlayerTypeKPISettings/{id}
Request Body None
Normal Response Code 200
Response Body None

4.13.Global Settings

4.13.1.Players

4.13.1.1.Content Check

Description Sets the content check settings for all players on the network
HTTP Method PUT
Url /globalsettings/players/contentcheck
Required Parameters
Name Description Data Type Response if omitted Permitted Values
type The type of content check, either at a set interval or daily string 400 setInterval: daily
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
interval The interval for content checks, in minutes int None This can be any value from 1 to 1440. This is required when ‘type’ is ‘setInterval’
time The time of day for content checks string None The format to be used is HH:MM:SS. This is required when ‘type’ is ‘daily’
separateRssSync Should RSS feeds by synced separately to content checks? boolean None True if RSS feeds should be synced separately to content checks, otherwise false.
Request Body None
Normal Response Code 200
Response Body None

4.13.1.2.Health Check

Description Sets the content check settings for all players on the network
HTTP Method PUT
Url /globalsettings/players/healthcheck
Required Parameters
Name Description Data Type Response if omitted Permitted Values
interval The interval for health checks, in minutes int 400 This can be any value from 1 to 1440.
Request Body None
Normal Response Code 200
Response Body None

4.13.1.3.Reboots

Description Sets the reboot settings for all players on the network
HTTP Method PUT
Url /globalsettings/players/reboots
Required Parameters
Name Description Data Type Response if omitted Permitted Values
enabled Enables or disables scheduled reboots boolean 400 True or false
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
time The time of day for reboots string 00:00:00 The format to be used is HH:MM:SS.
rebootAtNextContentCheck If true, players will reboot at the next content check. boolean None True or false
Request Body None
Normal Response Code 200
Response Body None

4.13.1.4.Proof of Play

Description Sets the content check settings for all players on the network. This will return forbidden if proof of play is not enabled on the network.
HTTP Method PUT
Url /globalsettings/players/proofofplay
Required Parameters
Name Description Data Type Response if omitted Permitted Values
enabled A boolean value to enable or disable proof of play boolean 400 True or false
Request Body None
Normal Response Code 200
Response Body None

4.13.1.5.Screen Control

Description Sets the screen control settings for all players on the network
HTTP Method POST
Url /globalsettings/players/screencontrol
Request Body A GlobalScreenControl object
Normal Response Code 200
Response Body None

4.14.Publish Content

4.14.1.Publish

Description Publish content to players
HTTP Method POST
Url /publish
Request Body A publication object
Normal Response Code 200
Response Body A list of PublishResult objects

4.14.1.1.Check

Description Checks the publication prior to publishing
HTTP Method POST
Url /publish/check
Request Body A publication object
Normal Response Code 200
Response Body A list of PublishResult objects

4.14.2.Player List

4.14.2.1.Get List

Description Gets all playerlists on the network
HTTP Method GET
Url /playerlists
Request Body None
Normal Response Code 200
Response Body A list of playerlist objects

4.14.2.2.Get

Description Gets a playerlist on the network
HTTP Method GET
Url /playerlists/{id}
Request Body None
Normal Response Code 200
Response Body A single playerlist object

4.14.2.3.Create

Description Saves a playerlist
HTTP Method POST
Url /playerlists
Request Body The new playerlist object
Normal Response Code 201
Response Body The playerlist object now with an ID

4.14.2.4.Update

Description Saves a playerlist
HTTP Method PUT
Url /playerlists/{ID}/
Request Body The playerlist object
Normal Response Code 200
Response Body The playerlist object with changes

4.14.3.Saved Search

4.14.3.1.Get All

Description Gets all saved searches on the network
HTTP Method GET
Url /savedsearches
Request Body None
Normal Response Code 200
Response Body A list of savedsearch objects

4.14.3.2.Get

Description Gets a single saved search on the network
HTTP Method GET
Url /savedsearches/{id}
Request Body None
Normal Response Code 200
Response Body A single savedsearch object

4.14.3.3.Create

Description Saves a saved search
HTTP Method POST
Url /savedsearches
Request Body The new SavedSearch object
Normal Response Code 201
Response Body The saved search object now with an ID

4.14.3.4.Update

Description Updates a saved search
HTTP Method PUT
Url /savedsearches/{ID}/
Request Body The SavedSearch object
Normal Response Code 200
Response Body The saved search object with updates

4.15.Users

4.15.1.Get All

Description Returns a collection of network user objects, that can be optionally filtered
HTTP Method GET
Url /users
Optional Parameters
Name Description Data Type Response if omitted Permitted Values
search Term to be used to compare against the user’s name or email address. If omitted then all users are returned string Empty String
start Starting position in the array of users, if omitted the default is 0 int 0
limit Number of users to return, int 50
order Specifies the order to return string email
  • email
status Specifies whether to return all users or only enabled or disabled users string all
  • all
  • enabled
  • disabled
role Specifies whether to return all user levels or a specific level string all
  • superadministrator
  • administrator
  • user
  • messagemanageruser
  • readonly
  • localuser
Request Body None
Normal Response Code 200
Response Body Array of network user objects

4.15.2.Create

Description Saves a user
HTTP Method POST
Url /users
Request Body The new network user object
Normal Response Code 201
Response Body The network user object now with an ID
Suggest Edit