API Programmer Guide for Cisco Digital Signs

Cisco Digital Media Suite 5.2.0

API Programmer Guide for Cisco Digital Signs
Version 0.8.5 Revised: September 13, 2010

Contents
About This Guide ................................................................................................................ 2 Who Should Use This Guide................................................................................................ 2 Introduction to Cisco DMS APIs .......................................................................................... 2 Getting Started ................................................................................................................... 2 Installation Notes ............................................................................................................ 3 Before You Begin ............................................................................................................ 3 Checking API Status ........................................................................................................ 4 Workflow ........................................................................................................................ 4 Making a Web Service Call .............................................................................................. 4 Digital Signs APIs ................................................................................................................. 5 DMP Groups .................................................................................................................... 6 DMPs ............................................................................................................................. 10 Content Asset Provisioning ........................................................................................... 14 Application provisioning ............................................................................................... 18 Playlist Provisioning ...................................................................................................... 19 Insertions and Requestors ............................................................................................ 21 Proof of Play.................................................................................................................. 25

© 2010 Cisco Systems, Inc. All rights reserved. This document is Cisco Public Information.

Page 1 of 28

API Programmer Guide for Cisco Digital Signs

Schedule Provisioning ................................................................................................... 26 Emergency .................................................................................................................... 27

About This Guide
Cisco Digital Signs is one component of Cisco Digital Media Suite (Cisco DMS). This guide describes Cisco APIs for third-party application developers whose products should extend or interoperate with Cisco Digital Signs. These APIs are a mechanism to insert, retrieve, update, and remove data. Similar guides on Cisco.com describe the APIs for other components of Cisco Digital Media Suite, such as Cisco Show and Share.

Who Should Use This Guide
This guide is a technical resource for application developers who build custom user interfaces, workflows, and vertical-specific applications that extend Cisco Digital Signs. You should have an advanced level of understanding of web technology, operation, and terminology and be familiar with Cisco Digital Signs. Application developers who use this application programming interface (API) should also have an understanding of a high-level programming language, such as Java or an equivalent language. Additionally, we recommend that you have knowledge of the following:
● ●

XML and XML Schema Representational State Transfer (REST) and RESTful Services

You should be familiar with using Cisco Digital Signs to manage your digital signage network. In most cases, API operations correlate to GUI operations.

Introduction to Cisco DMS APIs
This API uses the REST architecture, which leverages XML, HTTP, and HTTPS. This API executes requests by sending XML data to the API server. The server returns an XML response that combines an encoded REST message with an HTTP status code that states whether your request succeeded or failed. You can use this API to perform some of the same operations that are available in the web-based user interface for Cisco Digital Signs.
NOTE

Our implementations of Cisco DMS APIs might change over time in response to the changing needs of our partner community. We will maintain backward compatibility whenever possible but we encourage you to expect differences in future releases.

Getting Started
Topics in this section describe how to begin provisioning services with this API, verify the status of the API, and learn the steps in a typical workflow.

© 2010 Cisco Systems, Inc. All rights reserved. This document is Cisco Public Information.

Page 2 of 28

Page 3 of 28 .API Programmer Guide for Cisco Digital Signs Installation Notes Cisco Digital Signs includes all components for its own API. Before You Begin ATTENTION All applications that use API calls for Cisco Digital Signs must pass their XML data with the content type set to application/xml. Aside from the requirement for a Cisco Digital Media Manager (DMM) appliance that is configured and operating correctly. © 2010 Cisco Systems. The only user interfaces for this API are XML-encoded messages. All rights reserved. this API imposes no additional startup or shutdown requirements. Inc. This document is Cisco Public Information.

You must accept this warning manually every time you launch the DMS API Tester and you must also ensure programmatically that your API calls accept this self-signed certificate.0" encoding="UTF-8"?> <DmpGroup> <id>4</id> <name>ALL DMPs</name> <uri>http://:8080/xTAS-core/services/dmp/dmps/4/</uri> </DmpGroup> Workflow Each Digital Signs API call requires user authentication through the HTTP Basic Authentication method. f. h. For example: superuser Enter the administrator’s password. ATTENTION Digital Signs uses a self-signed SSL certificate in Cisco DMS 5.cisco. Making a Web Service Call The simplest way to make a web service call is to install the DMS API Tester AIR application. d. This application helps you to test your API calls. Enter the administrator’s username. e.com/air/ and install it on your computer.adobe. c. See Checking API Status above. Choose dmpGroup_getAll from the Template list. Download DMS_API_Tester. © 2010 Cisco Systems.cisco.com Install DMS_API_Tester. All Digital Signs APIs (except multipart file uploads) support and should use HTTPS over port 8443. All rights reserved. For example: digitalsigns.2. Complete these steps in DMS API Tester: a. and then open it.API Programmer Guide for Cisco Digital Signs Checking API Status NOTE Cisco Systems neither supports nor offers any warranties for DMS API Tester.air from http://developer. Accept the security alert. g. This triggers a security alert when the first request is made using the DMS API Tester.. Download the Adobe AIR runtime from http://get.com b. Inc.air. To test the APIs: 1. Your application should pass in the username and password on each API call to guarantee a valid logged in user. 4. Our partner community built and maintains this software utility. Click Submit. Choose xTAS-core/services/ From the Service list. This document is Cisco Public Information. Verify that you receive a response like this one: <?xml version="1. Page 4 of 28 . 2. Enter the fully qualified domain name (FQDN) of your DMM appliance in the Hostname field. 3.

there are four main base URL entry points for Digital Signs servicers. These APIs are RESTful. All rights reserved. This means that: You must set the content type for each request to “application/xml”. PUTs. and DELETEs. Additionally.API Programmer Guide for Cisco Digital Signs Digital Signs APIs Topics in this section describe APIs for operations that are specific to Cisco Digital Signs. GETs. Each request leverages some combination of POSTs. Inc. Page 5 of 28 . /xTAS-core/services/ /xTAS-core/api/rest/ /proofofplay_core/services/ /proofofplay_campaign/services/ © 2010 Cisco Systems. This document is Cisco Public Information.

Page 6 of 28 . Nonetheless. Add DMP Group This API allows for the creation of a new DMP group. All rights reserved. Get All DMP Groups This API returns the hierarchy of your DMP groups. we might document this result in a future revision to this guide. This document is Cisco Public Information. Nonetheless. Please ensure that you pass only valid parent IDs.API Programmer Guide for Cisco Digital Signs DMP Group Provisioning DMPs are organized in logical groups. ACTION URL PREREQUISITES POST /xTAS-core/services/dmpgroup/dmpgroups/ parentId: the ID of the parent group name: the name of the dmp group description: the description of the group REQUEST <n1:dmpGroup xmlns:n1="http://www. ACTION URL PREREQUISITES REQUEST RESULT GET /xTAS-core/services/dmpgroup/hierarchy/all/ N/A N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. © 2010 Cisco Systems. A less efficient and scalable approach is to schedule sequential deployments that target individual DMPs one-by-one. Inc.cisco.com/dms/xml/ns/dsm/dmpManagement"> <name>____DMP_GROUP_NAME____</name> <parentId>____DMP_GROUP_PARENT_ID____</parentId> <description>____DMP_GROUP_DESCRIPTION____</description> </n1:dmpGroup> The intended audience for this programmer guide can anticipate and understand the result that this API call returns. RESULT NOTE We do not perform any validation for the parent ID value. The “ALL DMPs” group at the root of this hierarchy contains all DMPs that are known to your DMM appliance. we might document this result in a future revision to this guide. This approach favors simultaneous deployments to all members of a DMP group.

NOTE Update DMP Group only updates: name. All rights reserved. we might document this result in a future revision to this guide. ACTION URL PREREQUISITES PUT /xTAS-core/services/dmpgroup/dmpgroups/{id} id: the ID of the dmp group parentId: the id of the parent group name: the name of the dmp group description: the description of the group REQUEST <n1:dmpGroup xmlns:n1="http://www.API Programmer Guide for Cisco Digital Signs Update a DMP Group This API allows one to update a DMP group. It does not update parent Id. Nonetheless. Page 7 of 28 .com/dms/xml/ns/dsm/dmpManagement"> <id>____DMP_GROUP_ID____</id> <name>____DMP_GROUP_NAME____</name> <parentId>____DMP_GROUP_PARENT_ID____</parentId> <description>____DMP_GROUP_DESCRIPTION____</description> </n1:dmpGroup> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. we might document this result in a future revision to this guide. description. Inc. Nonetheless. ACTION URL PREREQUISITES REQUEST RESULT DELETE /xTAS-core/services/dmpgroup/dmpgroups/{id} N/A N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Delete a DMP Group This API allows for the deletion of a new DMP group. This document is Cisco Public Information. and title. © 2010 Cisco Systems. ACTION URL PREREQUISITES GET /xTAS-core/services/dmpgroup/dmps/dmpgroup/{id} id: the ID of the group. Get DMPs that belong to a group This API allows for fetching all the DMPs that belong to a particular DMP Group. REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns.cisco. Nonetheless. we might document this result in a future revision to this guide.

Inc. This document is Cisco Public Information. Nonetheless.API Programmer Guide for Cisco Digital Signs Assign DMPs to a DMP groups This API allows for assigning existing DMP(s) to existing DMP Group(s).com/dms/xml/ns/dsm/dmpManagement"> <associationAction>set</associationAction> <dmpIdList> <id>____DMP_ID_1____</id> <id>____DMP_ID_2____</id> </dmpIdList> <dmpGroupIdList> <id>____DMP_GROUP_ID_1____</id> <id>____DMP_GROUP_ID_2____</id> </dmpGroupIdList> </n1:dmpGroupToDmpAssociation> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless.com/dms/xml/ns/dsm/dmpManagement"> <associationAction>unset</associationAction> <dmpIdList> <id>____DMP_ID_1____</id> <id>____DMP_ID_2____</id> </dmpIdList> <dmpGroupIdList> <id>____DMP_GROUP_ID_1____</id> <id>____DMP_GROUP_ID_2____</id> </dmpGroupIdList> </n1:dmpGroupToDmpAssociation> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns.cisco. ACTION URL PREREQUISITES PUT /xTAS-core/services/dmpgroup/dmpdmpgroup associationAction: make sure this set to “unset” dmpIdList id: the ids of the dmps you want to remove from the dmp groups dmpGroupIdList id: the ids of the dmp groups you want the dmps removed from. we might document this result in a future revision to this guide. ACTION URL PREREQUISITES PUT /xTAS-core/services/dmpgroup/dmpdmpgroup associationAction: make sure this set to “set” dmpIdList id: the ids of the dmps you want to add to the dmp groups dmpGroupIdList id: the ids of the dmp groups you want the dmps added to. REQUEST <n1:dmpGroupToDmpAssociation xmlns:n1="http://www.cisco. Page 8 of 28 . © 2010 Cisco Systems. All rights reserved. we might document this result in a future revision to this guide. Unassign DMP from DMP Group This API allows for removing existing DMP(s) from existing DMP Group(s). REQUEST <n1:dmpGroupToDmpAssociation xmlns:n1="http://www.

we might document this result in a future revision to this guide.com/dms/xml/ns/dsm/dmpManagement"> <dmpGroupIdList> <id>____DMP_GROUP_ID_1____</id> <id>____DMP_GROUP_ID_2____</id> </dmpGroupIdList> <parameters> <nvp> <name>____MIB_1____</name> <value>____MIB_VALUE_1____</value> </nvp> <nvp> <name>____MIB_2____</name> <value>____MIB_VALUE_2____</value> </nvp> </parameters> </n1:dmpConfigure> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. © 2010 Cisco Systems. Inc. This document is Cisco Public Information. All rights reserved.API Programmer Guide for Cisco Digital Signs Assigning DMP configuration parameters to DMP Groups This API sets configuration parameter(s) to all the DMPs in a DMP group. Valid parameter(s) and value(s) to set and in the correct order REQUEST <n1:dmpConfigure xmlns:n1="http://www.cisco. NOTE The values and parameters are defined in the Digital Media Player API documentation. ACTION URL PREREQUISITES PUT /xTAS-core/services/dmpgroup/dmpgroupsconfig/ dmpGroupIdList id: the ids of the dmp groups you want the dmps removed from. Nonetheless. Page 9 of 28 .

we might document this result in a future revision to this guide. we might document this result in a future revision to this guide. IP address. ACTION URL PREREQUISITES GET /xTAS-core/services/dmp/dmps/{id} id: the ID of the dmp REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. MAC address.API Programmer Guide for Cisco Digital Signs DMP Provisioning DMPs are the most granular target that can be used to deploy an application to a screen.com/dms/xml/ns/dsm/dmpManagement"> <name>____DMP_NAME____</name> <ipAddress>____DMP_IP____</ipAddress> <macAddress>____DMP_MAC_ADDRESS___</macAddress> <description>____DMP_DESCRIPTION____</description> </n1:dmp> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Inc. This document is Cisco Public Information. Nonetheless. © 2010 Cisco Systems. All rights reserved. Page 10 of 28 . Get DMP Details This API gives details about the DMP configuration: Name.cisco. Nonetheless. description and status (up or down). Add a DMP This API allows you to add a DMP to Digital Signs ACTION URL PREREQUISITES POST /xTAS-core/services/dmp/dmps name: the name of the dmp you are adding ipAddress: the ip address of the dmp you are adding macAddress: the mac address of the dmp you are adding description: the description of the dmp you are adding REQUEST <n1:dmp xmlns:n1="http://www.

Get DMP process status This API gets the status of the processes running on a DMP. we might document this result in a future revision to this guide. Nonetheless. Page 11 of 28 . Inc. Nonetheless. ACTION URL PREREQUISITES GET /xTAS-core/services/dmp/dmpprocesses/{id} id: the ID of the DMP REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. This document is Cisco Public Information. © 2010 Cisco Systems.cisco. ACTION URL PREREQUISITES PUT /xTAS-core/services/dmp/dmps/{id} id: the ID of the dmp you are updating name: the name of the dmp you are adding ipAddress: the ip address of the dmp you are adding macAddress: the mac address of the dmp you are adding description: the description of the dmp you are adding REQUEST <n1:dmp xmlns:n1="http://www. Delete DMP This API allows you to delete a DMP from Digital Signs ACTION URL PREREQUISITES DELETE /xTAS-core/services/dmp/dmps/{id} id: the id of the dmp REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless. we might document this result in a future revision to this guide. All rights reserved.com/dms/xml/ns/dsm/dmpManagement"> <id>____DMP_ID____</id> <name>____DMP_NAME____</name> <ipAddress>____DMP_IP____</ipAddress> <macAddress>____DMP_MAC_ADDRESS___</macAddress> <description>____DMP_DESCRIPTION____</description> </n1:dmp> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns.API Programmer Guide for Cisco Digital Signs Update DMP This API allows you to update a DMP that is already in Digital Signs. we might document this result in a future revision to this guide.

API Programmer Guide for Cisco Digital Signs Get DMP settings This API gets all the settings of a DMP ACTION URL PREREQUISITES GET /xTAS-core/services/dmp/dmpsettings/{id} id: the ID of the dmp REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns.cisco. Valid parameter(s) and value(s) to set and in the correct order REQUEST <n1:dmpConfigure xmlns:n1="http://www. Inc. we might document this result in a future revision to this guide. NOTE The values and parameters are defined in the Digital Media Player API documentation. Nonetheless. we might document this result in a future revision to this guide.com/dms/xml/ns/dsm/dmpManagement"> <dmpIdList> <id>____DMP_ID_1____</id> <id>____DMP_ID_2____</id> </dmpIdList> <parameters> <nvp> <name>____MIB_1____</name> <value>____MIB_VALUE_1____</value> </nvp> <nvp> <name>____MIB_2____</name> <value>____MIB_VALUE_2____</value> </nvp> </parameters> </n1:dmpConfigure> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. ACTION URL PREREQUISITES PUT /xTAS-core/services/dmp/dmpsconfig/ dmpGroupIdList id: the ids of the dmp groups you want the dmps removed from. Page 12 of 28 . Nonetheless. This document is Cisco Public Information. © 2010 Cisco Systems. Assign configuration parameters to DMP(s) This API sets configuration parameters on DMP(s). All rights reserved.

API Programmer Guide for Cisco Digital Signs Publish application to a DMP This API publishes an application to a DMP. we might document this result in a future revision to this guide. Therefore. Nonetheless. ACTION URL PREREQUISITES POST /xTAS-core/api/rest/application/{app_id}/dmp/{dmp_id} app_id: the ID of athe application you want to publish dmp_id: the ID of the dmp you want the application published to REQUEST RESULT <application/> The intended audience for this programmer guide can anticipate and understand the result that this API call returns. © 2010 Cisco Systems. this API will return an HTTP status code “200 OK” message even when you pass an DMP ID that is not valid. if you do not pass it you will get a 404 Not Found exception. All rights reserved. Inc. Page 13 of 28 . This document is Cisco Public Information. NOTE We do not validate the DMP ID . Please ensure that you pass the “<application/>” tag.

Page 14 of 28 . ACTION URL PREREQUISITES REQUEST RESULT GET /xTAS-core/services/content/categories/ N/A N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless. we might document this result in a future revision to this guide.2. All rights reserved. Assets have to be wrapped in applications to be deployed to DMPs. NOTE In Cisco DMS 5. Assets can not directly be deployed to DMPs. Nonetheless.API Programmer Guide for Cisco Digital Signs Content Asset Provisioning Assets in Digital Signs are files that are used to create applications. update or delete asset categories. The smallest application that can be deployed to a sign is a single asset inside of a playlist (playlist is an application). Get Content Asset List for a Category This API returns a list of the assets in a particular category. Each asset can only belong to one category branch. This API is used to identify each category. This document is Cisco Public Information. Inc. These APIs allow for the creation and management of Digital Signs’ assets. you cannot use this API to add. we might document this result in a future revision to this guide. ACTION URL PREREQUISITES REQUEST RESULT GET /xTAS-core/services/content/assets/category/{id} id: the ID of the category N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. © 2010 Cisco Systems. Get Category Tree Assets are organized in hierarchical categories.

Nonetheless. This document is Cisco Public Information.UDP.cisco. IMAGES.com/dms/xml/ns/dsm/contentManagement" > <title>____ASSET_TITLE____</title> <fileName>____ASSET_FILE_NAME___</fileName> <description>____ASSET_DESCRIPTION____</description> <fileType>____VALID_FILE_TYPE____</fileType> <estimatedDuration> <Hours>0</Hours> <Minutes>0</Minutes> <Seconds>0</Seconds> </estimatedDuration> <categoryIdList> <id>____CATEGORY_ID____</id> </categoryIdList> <assetOwner>____USER_NAME____</assetOwner> <storageType>file</storageType> <downloadurl>true</downloadurl> </n1:asset> REQUEST RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. HTML. All rights reserved. we might document this result in a future revision to this guide. ACTION URL PREREQUISITES POST /xTAS-core/services/content/assets/ title: the title for the asset filename: the file’s name description: the description of the file fileType: can be FLASH. or VIDEO estimatedDuration: the default amount of time the asset should stay on screen categoryIdList id: the ID of the category the asset should belong to assetOwner: the username of the owner adding the asset This sample HTML file shows how to upload an asset: <html> <body> <form action="http://____YOUR_HOSTNAME____:8080/xTAScore/services/content/assets/" enctype="multipart/form-data" method="POST"> File to upload: <input type="file" name="upload_file"/> <br/> data: <textarea cols="40" rows="20" name="data"></textarea> <br/> <input type="submit" value="Upload"/> </form> </body> </html> “data” should be of the XML format: <n1:asset xmlns:n1="http://www. Inc. This multipart form uploads a file with the input name “upfile” and also the xml with the input name “data”. Uploading an asset is done through a multi-part form. © 2010 Cisco Systems. Page 15 of 28 .API Programmer Guide for Cisco Digital Signs Upload an Asset This API is used to create a new asset in the Digital Signs’ media library by uploading a file.

Verify that DNS settings are correct in the Application Administration Interface (AAI) command shell. All rights reserved.com/dms/xml/ns/dsm/contentManagement" > <title>____ASSET_TITLE____</title> <fileName>____ASSET_FILE_NAME___</fileName> <description>____ASSET_DESCRIPTION____</description> <fileType>____VALID_FILE_TYPE____</fileType> <estimatedDuration> <Hours>0</Hours> <Minutes>0</Minutes> <Seconds>0</Seconds> </estimatedDuration> <categoryIdList> <id>____CATEGORY_ID____</id> </categoryIdList> <assetOwner>____USER_NAME____</assetOwner> <storageType>url</storageType> <downloadurl>true</downloadurl> </n1:asset> NOTE ● Titles must be unique and cannot be blank.cisco. Uploading an asset is done through a multi-part form. © 2010 Cisco Systems. ACTION URL PREREQUISITES POST /xTAS-core/services/content/assets/ title: thte title for the asset filename: the url to the file description: the description of the file fileType: can be FLASH. This multipart form only contains an xml with the input name “data”.API Programmer Guide for Cisco Digital Signs Add Asset from URL This API is used to create a new asset in the Digital Signs’ media library from a valid URL. This document is Cisco Public Information. ● Please ensure that your DMM appliance can resolve any URL that you use the API to pass. Inc. IMAGES. Page 16 of 28 . HTML. or VIDEO estimatedDuration: the default amount of time the asset should stay on screen categoryIdList id: the ID of the category the asset should belong to assetOwner: the username of the owner adding the asset REQUEST This sample HTML illustrates how to upload an asset: <html> <body> <form action="http://____YOUR_HOSTNAME____:8080/xTAScore/services/content/assets/" enctype="multipart/form-data" method="POST"> data: <textarea cols="40" rows="20" name="data"></textarea> <br/> <input type="submit" value="Upload"/> </form> </body> </html> “data” should be of the xml format: <n1:asset xmlns:n1="http://www.UDP.

This document is Cisco Public Information.com/dms/xml/ns/dsm/contentMan agement"> <id>____ASSET_ID____</id> <assetBasic> <title>____ASSET_TITLE____</title> <fileName>____ASSET_FILE_NAME___</fileName> <description>____ASSET_DESCRIPTION____</description> <fileType>____VALID_FILE_TYPE____</fileType> <estimatedDuration> <Hours>0</Hours> <Minutes>0</Minutes> <Seconds>0</Seconds> </estimatedDuration> <categoryIdList> <id>____CATEGORY_ID____</id> </categoryIdList> <assetOwner>____USER_NAME____</assetOwner> <storageType>____url_OR_file____</storageType> <downloadurl>true</downloadurl> </assetBasic> <keepexisting>true</keepexisting> </n1:editAsset> © 2010 Cisco Systems. we might document this result in a future revision to this guide. ACTION URL PREREQUISITES GET /xTAS-core/services/content/assets/{id} id: the asset ID REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Inc.API Programmer Guide for Cisco Digital Signs Get Asset Details This API returns details about a specific asset. ACTION URL PREREQUISITES POST /xTAS-core/services/content/assets/ The asset details should be retrieved first using “Get Asset details” API above REQUEST This sample HTML illustrates how to upload an asset: <html> <body> <form action="http://____YOUR_HOSTNAME____:8080/xTAScore/services/content/assets/" enctype="multipart/form-data" method="POST"> data: <textarea cols="40" rows="20" name="data"></textarea> <br/><input type="submit" value="Upload"/> </form> </body> </html> “data” should be of the xml format: <n1:editAsset xmlns:n1="http://www. Nonetheless. Update Asset This API helps you to edit the metadata for a specific asset.cisco. All rights reserved. Page 17 of 28 .

All rights reserved. Nonetheless. we might document this result in a future revision to this guide.2 APIs do not expose the creation or deletion of applications. we might document this result in a future revision to this guide. Get all Applications This API returns a list of all applications. ACTION URL PREREQUISITES REQUEST RESULT GET /xTAS-core/services/app/apps/ N/A N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. This document is Cisco Public Information. NOTE Except for the Playlist application.API Programmer Guide for Cisco Digital Signs Delete Asset This API helps you to delete an asset from the media library. Page 18 of 28 . © 2010 Cisco Systems. DMS 5. Inc. Application Provisioning Applications are the smallest unit in Digital Signs that can be deployed to a DMP or a DMP group. ACTION URL PREREQUISITES DELETE /xTAS-core/services/content/assets/{id} id: the asset ID REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless.

1024X768 randomize: “true” if the playlist order should be random.w3. © 2010 Cisco Systems. Inc. ACTION GET URL PREREQUISITES REQUEST RESULT /xTAS-core/api/rest/playlist/detail/{id} id: the ID of the playlist N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns.org/2001/XMLSchema-instance" xmlns:n2="http://www.Playlists A playlist is a Digital Signs application which plays and loops Digital Signs assets. ACTION URL PREREQUISITES POST /xTAS-core/api/rest/playlist resolution: e. or the amount of minutes for the asset to stay on screen seconds: can be set to 0. Get playlist details This API returns information about a particular playlist.g. we might document this result in a future revision to this guide. otherwise “false” popEnable: “true” if proof of play should be used on this playlist. Page 19 of 28 . Add a Playlist This API helps you to create a playlist. otherwise “false” description: the description of the playlist title: the title of the playlist hours: can be set to 0. or the amount of seconds for the asset to stay on screen assetId: the asset to be used REQUEST <n2:playlist xmlns:xsi="http://www.API Programmer Guide for Cisco Digital Signs Application Provisioning . This document is Cisco Public Information. Nonetheless.com/dms/xml/ns/playlistManage ment"> <n2:resolution>____RESOLUTION____</n2:resolution> <n2:randomize>____IS_RANDOMIZED____</n2:randomize> <n2:popEnable>____IS_POP_ENABLED____</n2:popEnable> <n2:description>____DESCRIPTION____</n2:description> <n2:owner>____USERNAME____</n2:owner> <n2:title>____TITLE____</n2:title> <n2:playlistItems> <n2:item> <n2:plannedDuration> <n2:hours>____HOURS____</n2:hours> <n2:minutes>____MINUTES____</n2:minutes> <n2:seconds>____SECONDS____</n2:seconds> </n2:plannedDuration> <n2:asset> <n2:assetId>____ASSET_ID____</n2:assetId> </n2:asset> </n2:item> </n2:playlistItems> </n2:playlist> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless. we might document this result in a future revision to this guide. All rights reserved. or the amount of hours for the asset to stay on screen minutes: can be set to 0.cisco.

Nonetheless. ACTION URL PREREQUISITES REQUEST RESULT DELETE /xTAS-core/api/rest/playlist/{id} id: the ID of the playlist N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns.cisco. Delete playlist This API helps you to delete a playlist.com/dms/xml/ns/playlistManagement"> <n2:id>____PLAYLIST_ID____</n2:id> <n2:resolution>____RESOLUTION____</n2:resolution> <n2:randomize>____IS_RANDOMIZED____</n2:randomize> <n2:popEnable>____IS_POP_ENABLED____</n2:popEnable> <n2:description>____DESCRIPTION____</n2:description> <n2:owner>____USERNAME____</n2:owner> <n2:title>____TITLE____</n2:title> <n2:playlistItems> <n2:item> <n2:plannedDuration> <n2:hours>____HOURS____</n2:hours> <n2:minutes>____MINUTES____</n2:minutes> <n2:seconds>____SECONDS____</n2:seconds> </n2:plannedDuration> <n2:asset> <n2:assetId>____ASSET_ID____</n2:assetId> </n2:asset> </n2:item> </n2:playlistItems> </n2:playlist> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. or the amount of hours for the asset to stay on screen minutes: can be set to 0.org/2001/XMLSchema-instance" xmlns:n2="http://www. This document is Cisco Public Information. otherwise “false” description: the description of the playlist title: the title of the playlist hours: can be set to 0. Page 20 of 28 . Inc.g. Nonetheless.w3. or the amount of seconds for the asset to stay on screen assetId: the asset to be used REQUEST <n2:playlist xmlns:xsi="http://www. we might document this result in a future revision to this guide. All rights reserved. © 2010 Cisco Systems.API Programmer Guide for Cisco Digital Signs Edit a playlist This API helps you to edit a playlist ACTION PUT URL PREREQUISITES /xTAS-core/api/rest/playlist/{id} id: the ID of the playlist resolution: e. or the amount of minutes for the asset to stay on screen seconds: can be set to 0. we might document this result in a future revision to this guide. otherwise “false” popEnable: “true” if proof of play should be used on this playlist. 1024X768 randomize: “true” if the playlist order should be random.

Nonetheless. when we generate Proof of Play reports.cisco. We use information about Requestors and Insertions both. A note on nomenclature: Insertions and Requestors were previously named Campaigns and Agencies. ACTION URL PREREQUISITES REQUEST RESULT GET /proofofplay_campaign/services/agencies N/A N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. the API calls themselves still refer to the older terms.2 introduces two new concepts: Insertions and Requestors. This document is Cisco Public Information. Inc. A Requestor is a named entity that makes use of named Insertions. we might document this result in a future revision to this guide. Nonetheless. Page 21 of 28 . ACTION URL PREREQUISITES POST /proofofplay_campaign/services/agencies name: the name of the Requestor description: the description of the Requestor REQUEST <ns2:agency xmlns:ns2="http://www. ACTION URL PREREQUISITES REQUEST RESULT GET /proofofplay_campaign/services/agencies/{id} id: the Requestor id N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Get Requestor detail This API returns details about a particular Requestor. Insertions are containers for assets.API Programmer Guide for Cisco Digital Signs Insertion and Requestor Provisioning Cisco DMS 5. All rights reserved. © 2010 Cisco Systems. Create new Requestor This API helps you to create a new Requestor.com/dms/xml/ns/campaignManagement"> <name>____REQUESTOR_NAME____</name> <description>__REQUESTOR_DESCRIPTION____</description> </ns2:agency> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. respectively. Get All Requestors This API returns a list of all named Requestors. Nonetheless. we might document this result in a future revision to this guide. we might document this result in a future revision to this guide. While this update in nomenclature is used throughout this document.

API Programmer Guide for Cisco Digital Signs Edit Requestor This API helps you to edit the metadata that describes a Requestor. Nonetheless.com/dms/xml/ns/campaignManagement"> <name>____REQUESTOR_NAME____</name> <description>__REQUESTOR_DESCRIPTION____</description> </ns2:agency> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. they should be >=1 REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless. ACTION URL PREREQUISITES PUT /proofofplay_campaign/services/agencies/{id} id: the ID of the Requestor name: the name of the Requestor description: the description of the Requestor REQUEST <ns2:agency xmlns:ns2="http://www. Get list of Insertions This API is used to get a list of Insertions ACTION URL PREREQUISITES GET /proofofplay_campaign/services/campaigns?start={startValue}&limit={limitValu e} Pagination params are optional. All rights reserved. Page 22 of 28 . Inc. © 2010 Cisco Systems. If they exist. Delete Requestor This API helps you to delete a Requestor. we might document this result in a future revision to this guide. This document is Cisco Public Information. we might document this result in a future revision to this guide.cisco. Nonetheless. ACTION URL PREREQUISITES DELETE /proofofplay_campaign/services/agencies/{id} id: the ID of the Requestor REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. we might document this result in a future revision to this guide.

Page 23 of 28 . ACTION URL PREREQUISITES PUT /proofofplay_campaign/services/campaigns/{id} insertionId: the ID of the Insertion name: the name of the Insertion startDate: the start date of the Insertion requestorId: the ID of the Requestor the insertion belongs to resource id: the ID of the application this insertion should track © 2010 Cisco Systems. This document is Cisco Public Information. All rights reserved.API Programmer Guide for Cisco Digital Signs Add New Insertion This API is used to add a new Insertion ACTION URL PREREQUISITES POST /proofofplay_campaign/services/campaigns name: the name of the insertion startDate: the start date of the insertion requestorId: the ID of the Requestor the insertion belongs to resource id: the ID of the application this insertion should track REQUEST <ns2:campaign xmlns:ns2="http://www.com/dms/xml/ns/campaignManag ement"> <name>____INSERTION_NAME____</name> <description>____INSERTION_DESCRIPTION____</description> <startDate>__START_DATE__YYYY-MM-DD____</startDate> <endDate>__OPTIONAL_END_DATE__YYYY-MM-DD____</endDate> <agencyId>____REQUESTOR_ID____</agencyId> <resources> <resource> <id>____APPLICATION_ID____</id> <resourceType>DSM::APPLICATION</resourceType> </resource> </resources> </ns2:campaign> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless. Edit Insertion This API is used to update a particular Insertion.cisco. Inc. we might document this result in a future revision to this guide.

All rights reserved. Page 24 of 28 .com/dms/xml/ns/campaignManag ement"> <name>____INSERTION_NAME____</name> <description>___INSERTION_DESCRIPTION____</description> <startDate>__START_DATE__YYYY-MM-DD____</startDate> <endDate>__OPTIONAL_END_DATE__YYYY-MM-DD____</endDate> <agencyId>____REQUESTOR_ID____</agencyId> <resources> <resource> <id>____APPLICATION_ID____</id> <resourceType>DSM::APPLICATION</resourceType> </resource> </resources> </ns2:campaign> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. © 2010 Cisco Systems. we might document this result in a future revision to this guide. we might document this result in a future revision to this guide.cisco.API Programmer Guide for Cisco Digital Signs REQUEST <ns2:campaign xmlns:ns2="http://www. Inc. Delete Insertion This API is used to delete a particular Insertion.com/dms/xml/ns/campaignManagement"> <id>____INSERTION_ID____</id> </ns2:campaignDeletion> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. This document is Cisco Public Information. Nonetheless. ACTION URL PREREQUISITES POST /proofofplay_campaign/services/campaigns/batchDeletion insertionId: the ID of the insertion you want to delete REQUEST <ns2:campaignDeletion xmlns:ns2="http://www. Nonetheless.cisco.

ACTION URL PREREQUISITES GET /proofofplay_core/services/reports/ERROR/CAMPAIGN/{id}/fromDate/{YYYYMM DD}/toDate/{YYYYMMDD}/ id: Insertion id fromDate: desired start date of the report toDate: desired end date of the report REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. we might document this result in a future revision to this guide.API Programmer Guide for Cisco Digital Signs Proof of Play Proof of Play APIs allow you to generate reports for each Insertion. Nonetheless. we might document this result in a future revision to this guide. Page 25 of 28 . © 2010 Cisco Systems. Nonetheless. All rights reserved. Inc. Nonetheless. Get Insertion error reports This API returns an error report for a particular Insertion. Get Insertion summary reports This API returns a summary report for a particular Insertion. ACTION URL PREREQUISITES GET /proofofplay_core/services/reports/SUCCESS/CAMPAIGN/{id}/fromDate/{YYYY MMDD}/toDate/{YYYYMMDD}/ id: insertion id fromDate: desired start date of the report toDate: desired end date of the report REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Get Insertion success reports This API returns a success report for a particular Insertion. ACTION URL PREREQUISITES GET /proofofplay_core/services/reports/SUCCESS/CAMPAIGN/{id}/fromDate/{YYYY MMDD}/toDate/{YYYYMMDD}/ id: insertion id fromDate: desired start date of the report toDate: desired end date of the report REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. This document is Cisco Public Information. we might document this result in a future revision to this guide.

This document is Cisco Public Information. Page 26 of 28 . © 2010 Cisco Systems. Nonetheless. All rights reserved. Get all applications scheduled for a date This API returns a list of all applications that are scheduled to deploy on a given date. Inc.API Programmer Guide for Cisco Digital Signs Schedule Provisioning These APIs help you see future deployments of applications to DMPs. ATTENTION This API requires media type to be set to “text/xml” NOT “application/xml” ACTION URL PREREQUISITES GET /xTAS-core/api/rest/scheduler/schedule/date/{YYYY-MM-DD} date: the date for which you’d like to get the schedule REQUEST RESULT N/A The intended audience for this programmer guide can anticipate and understand the result that this API call returns. we might document this result in a future revision to this guide.

This document is Cisco Public Information. Page 27 of 28 .API Programmer Guide for Cisco Digital Signs Emergency These APIs help you to override the saved schedule and publish an emergency application to a group of DMPs. we might document this result in a future revision to this guide. ACTION URL PREREQUISITES POST /xTAS-core/api/rest/emergency/start emergencyApplication id: the ID of the application to use as an emergency group id: the ID of the group to which the emergency application applies REQUEST <singleEmergencyStart xsi:noNamespaceSchemaLocation="http://www. Inc.w3.cisco. we might document this result in a future revision to this guide. RESULT © 2010 Cisco Systems.com/dms/emergency/xsd/ap i/Emergency. Start Emergency Messaging This API starts the emergency.xsd" xmlns:xsi="http://www. All rights reserved. ACTION URL PREREQUISITES POST /xTAS-core/api/rest/emergency/stop group id: the ID of the group to which the emergency application applies REQUEST <singleEmergencyStop> <groupList> <group id="__DMP_GROUP_ID____"/> </groupList> </singleEmergencyStop> The intended audience for this programmer guide can anticipate and understand the result that this API call returns.org/2001/XMLSchema-instance"> <emergencyApplication id="____APPLICATION_ID____"> <groupList> <group id="____DMP_GROUP_ID____"/> </groupList> </emergencyApplication> </singleEmergencyStart> RESULT The intended audience for this programmer guide can anticipate and understand the result that this API call returns. Nonetheless. Nonetheless. Stop Emergency messaging This API stops the emergency.

Inc. This document is Cisco Public Information. Page 28 of 28 . All rights reserved.API Programmer Guide for Cisco Digital Signs Printed in USA CXX-XXXXXX-XX 01/10 © 2010 Cisco Systems.

Sign up to vote on this title
UsefulNot useful