{"info":{"_postman_id":"0a5c2db8-1356-4854-9fa9-457abdb67451","name":"Universal Player Runtime API","description":"

Welcome

\n

Welcome to the Cnario Runtime API (Universal Player) documentation.

\n

This document was tested and valided on Cnario UP versions 3.8-3.9.1.

\n

For any issues, please contact the YCD Support team.

\n

Installation / Setup

\n

In order to start using the Cnario Runtime Player API you should follow these easy steps:

\n
    \n

  1. Stop playback on your player

    \n
    2. \n

  2. Settings -> Remote Devices

    \n
    3. \n

  3. Enable the \"Use REST\" feature

    \n
    4. \n

  4. Click OK

    \n
    5. \n

  5. Close the Cnario Player application

    \n
    6. \n

  6. If you want to change the default port (8080) to something else, follow these steps, otherwise, jump to step 7

    \n
      \n

    1. Open the \"C-nario Player.exe.config\" with a text editor (default path: \"C:\\Program Files (x86)\\C-nario\\C-nario Universal Player\\C-nario Player.exe.config\")

      \n
      2. \n

    2. Find the \"Service\" named \"WCFCommunicationREST\"

      \n
      3. \n

    3. Change the value of the key named \"baseAddress\" to address you'd like to use

      \n
      4. \n
    \n
    7. \n

  7. Run the Cnario Player application

    \n
    8. \n
\n

Authentication

\n

By default there is no authentication for this API, it should only be accessible to devices within the same network as the Player.

\n

If you'd like, you can configure a \"Safe Sender\" list in the Settings->Remote Devices form.

\n

Error codes

\n

Assuming that the request URL is correct, you will almost always get a 200 - OK response, the error itself will appear within the response (deivce does not exist / pin does not exist / value out of range).

\n

Rate Limits

\n

Since this API is provided by the Cnario Universal Player application installed locally on your system, there are no software imposed rate limits, just keep in mind that any API call will utilize resources.

\n

Environment variables

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome","slug":"welcome"},{"content":"Installation / Setup","slug":"installation-setup"},{"content":"Authentication","slug":"authentication"},{"content":"Error codes","slug":"error-codes"},{"content":"Rate Limits","slug":"rate-limits"},{"content":"Environment variables","slug":"environment-variables"}],"owner":"27208562","collectionId":"0a5c2db8-1356-4854-9fa9-457abdb67451","publishedId":"2sAXqng5D5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-16T20:29:03.000Z"},"item":[{"name":"Actions","item":[{"name":"Get Device List","id":"3471817a-3ee2-4848-b141-d8728b57b5ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{PlayerAPIHost}}/Cnario/REST/GetDeviceList","description":"

Display all of the available devices on the player

\n","urlObject":{"path":["Cnario","REST","GetDeviceList"],"host":["{{PlayerAPIHost}}"],"query":[],"variable":[]}},"response":[{"id":"0ade94f9-055a-438f-abee-7a753141f342","name":"Get Device List","originalRequest":{"method":"GET","header":[],"url":"{{PlayerAPIHost}}/cnario/rest/getdevicelist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:32:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"GetDeviceListResult\": {\n \"Devices\": [\n \"AvailableLayoutsDevice\",\n \"CanvasControllerDeviceCanvas Controller - 1\",\n \"CanvasControllerDeviceCanvas Controller -2\",\n \"Microphone Array (Realtek High \",\n \"SchedulerDevice\",\n \"SneakerNetDevice\",\n \"Speaker/HP (Realtek High Defini\",\n \"SystemDevice\"\n ],\n \"ServiceStatus\": \"Success\"\n }\n}"}],"_postman_id":"3471817a-3ee2-4848-b141-d8728b57b5ef"},{"name":"Get Device","id":"023c9b36-9ca9-4616-a929-f18a02cdac01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PlayerAPIHost}}/Cnario/REST/GetDevice?deviceName=SystemDevice","description":"

Returns all of the PINs of a specific device

\n","urlObject":{"path":["Cnario","REST","GetDevice"],"host":["{{PlayerAPIHost}}"],"query":[{"key":"deviceName","value":"SystemDevice"}],"variable":[]}},"response":[{"id":"1e11a5e9-df14-4130-95d3-621f942319af","name":"Valid - Get Device","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/getdevice?deviceName=SystemDevice","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","getdevice"],"query":[{"key":"deviceName","value":"SystemDevice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:34:55 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"GetDeviceResult\": {\n \"Device\": {\n \"DeviceName\": \"SystemDevice\",\n \"DevicePins\": [\n {\n \"Description\": \"Total Available Ram\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Total Physical Memory\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"17012088832\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtDecimal\"\n },\n {\n \"Description\": \"CPU Usage\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"CPU Usage\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"35.55\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtDecimal\"\n },\n {\n \"Description\": \"Date\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Date\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"13/9/2024\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Time\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Time\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"13:34:54\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"SetDate\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"SetDate\",\n \"PinType\": \"Input\",\n \"PinValue\": null,\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"SetTime\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"SetTime\",\n \"PinType\": \"Input\",\n \"PinValue\": null,\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Set date & time by ticks\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"SetDateTime\",\n \"PinType\": \"Input\",\n \"PinValue\": null,\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"System Type\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"System Type\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"x64-based PC\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Operating System Version\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Operating System Version\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"10.0.19045\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Operating System Type\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Operating System\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"Microsoft Windows 10 Pro\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Computer System Model\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Model\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"20HNCTO1WW\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Computer System Manufacturer\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Manufacturer\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"LENOVO\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Computer System Name\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"Computer Name\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"IDOLENOVO\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Provides information on Player version.\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Versions\",\n \"PinName\": \"Player Version\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"3.9.1.405\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Provides information on Player installation date.\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Versions\",\n \"PinName\": \"Install Date\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Total free space in Transporter folder.\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Transporter\",\n \"PinName\": \"Chainmail Free Space in GB\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"47.704303741455078125\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtDecimal\"\n },\n {\n \"Description\": \"Total Size in Transporter folder.\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Transporter\",\n \"PinName\": \"Chainmail Total Size in GB\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"475.692378997802734375\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtDecimal\"\n },\n {\n \"Description\": \"Available Memory in MB\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Transporter\",\n \"PinName\": \"Available Memory in MB\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"2461\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtDecimal\"\n },\n {\n \"Description\": \"Provides information on Transporter communication module version.\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Versions\",\n \"PinName\": \"Chainmail Version\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \" Build 319.A 3.8.5(.NET 4.5.2)\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Contain the last broadcast message that was received.\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Chainmail Broadcast Message\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Indicate if the chainmail connected to master\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Chainmail Connected\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"False\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n },\n {\n \"Description\": \"Name of the master chainmail connected to\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Chainmail Connected Master\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Redundancy\",\n \"PinName\": \"Spare Redundant\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"False\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Certification\",\n \"PinName\": \"Certificate Expiration\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"1/1/3000 12:00:00 AM\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"Certification\",\n \"PinName\": \"Certificate String\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"[User Name]\\r\\nIDOLENOVO\\r\\n[ComputerID]\\r\\nRD7B4E5AF0,MA780A7D3F,MA7975093C\\r\\n[Application]\\r\\nC-nario Universal Player\\r\\n[Mode]\\r\\nFull Mode\\r\\n[Date]\\r\\n1/1/3000\\r\\n[Parameters]\\r\\nAdvanced Flash=Enabled;Analog clock=Enabled;Collage Mode=Enabled;Device Rules=Enabled;Flexi-Text=Enabled;FreeForm Seamless Mode=Enabled;HDoIP=Enabled;Low Latency Streaming=Enabled;Max Height=4096;Max Width=4096;Multi streamer=Enabled;New webby=Enabled;Number of Canvas Screens=1;Number of Channels=1;Number of windows=0;Phantom=Enabled;PlaylistCI=Enabled;RSS feed=Enabled;RSS media=Enabled;Slide Show=Enabled;SMS airports=Enabled;SMS stocks=Enabled;UDP Transmission Mode=Enabled;Vizky=Enabled;Web Browser=Enabled;Web Local editor=Enabled;WM Streaming=Enabled\\r\\n[Certificate]\\r\\n\\r\\n\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"EventsLogging\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Log Events\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"False\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"EventsLogging\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Delay Events Report\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"1000\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtInteger\"\n },\n {\n \"Description\": \"Restart or reboot the player\",\n \"MajorGrouping\": \"Recovery\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Recovery\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"None\"\n ],\n \"SetDefinition\": [\n \"None\",\n \"Restart Application\",\n \"Reboot Computer\",\n \"Shutdown Computer\"\n ],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtSet\"\n },\n {\n \"Description\": \"Identify Screens\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Identify Screens\",\n \"PinType\": \"Input\",\n \"PinValue\": null,\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n },\n {\n \"Description\": \"Certification\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Set New Certification\",\n \"PinType\": \"Input\",\n \"PinValue\": null,\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Copy received files to relative path\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Copy Received Files\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"False\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n },\n {\n \"Description\": \"Copy received files to target root path\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Copy Received Files Target\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Data Pipe Server\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"http://localhost\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Data Pipe Secret\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"YCDDPDefaultSecret\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtString\"\n },\n {\n \"Description\": \"Playback Device\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Device Canvas Controller -2\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"False\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n },\n {\n \"Description\": \"Playback Device\",\n \"MajorGrouping\": \"\",\n \"MinorGrouping\": \"\",\n \"PinName\": \"Device Canvas Controller - 1\",\n \"PinType\": \"Input\",\n \"PinValue\": [\n \"False\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtBool\"\n }\n ]\n },\n \"ServiceStatus\": \"Success\"\n }\n}"},{"id":"f6ee3439-6a5c-4760-9f77-077679c4882d","name":"Error - no device - Get Device","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/getdevice?deviceName=SystemDevice2","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","getdevice"],"query":[{"key":"deviceName","value":"SystemDevice2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:35:39 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"GetDeviceResult\": {\n \"Device\": null,\n \"ServiceStatus\": \"Error Calling GetDevice: System.ServiceModel.FaultException: Error: Device was not found:SystemDevice2\\r\\n at NewCE.WCFOperations.GetDevice(String deviceName)\\r\\n at NewCE.WCFCommunicationREST.GetDevice(String deviceName)\"\n }\n}"}],"_postman_id":"023c9b36-9ca9-4616-a929-f18a02cdac01"},{"name":"Get Pin","id":"733db93e-ae42-4c07-af92-34a4d3b4e985","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PlayerAPIHost}}/Cnario/REST/GetPin?deviceName=SystemDevice&PinName=CPU Usage","description":"

Returns all of the properties of a specific PIN

\n","urlObject":{"path":["Cnario","REST","GetPin"],"host":["{{PlayerAPIHost}}"],"query":[{"key":"deviceName","value":"SystemDevice"},{"key":"PinName","value":"CPU Usage"}],"variable":[]}},"response":[{"id":"e2d852e2-f39e-4a3c-9d0c-b22050eda88e","name":"Get Pin","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/Cnario/REST/GetPin?deviceName=SystemDevice&PinName=CPU Usage","host":["{{PlayerAPIHost}}"],"path":["Cnario","REST","GetPin"],"query":[{"key":"deviceName","value":"SystemDevice"},{"key":"PinName","value":"CPU Usage"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:44:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"GetPinResult\": {\n \"Pin\": {\n \"Description\": \"CPU Usage\",\n \"MajorGrouping\": \"System Information\",\n \"MinorGrouping\": \"General Information\",\n \"PinName\": \"CPU Usage\",\n \"PinType\": \"Info\",\n \"PinValue\": [\n \"23.05\"\n ],\n \"SetDefinition\": [],\n \"ValidValueRange\": null,\n \"ValueType\": \"vtDecimal\"\n },\n \"ServiceStatus\": \"Success\"\n }\n}"}],"_postman_id":"733db93e-ae42-4c07-af92-34a4d3b4e985"},{"name":"Get Pin Value","id":"6f84e0cb-af95-452c-8010-009d0b39954e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PlayerAPIHost}}/Cnario/REST/GetPinValue?deviceName=SystemDevice&pinName=CPU Usage","description":"

Returns just the value of a specific PIN

\n","urlObject":{"path":["Cnario","REST","GetPinValue"],"host":["{{PlayerAPIHost}}"],"query":[{"key":"deviceName","value":"SystemDevice"},{"key":"pinName","value":"CPU Usage"}],"variable":[]}},"response":[{"id":"1e228256-0ba5-4ca4-8fa8-3f1ddc0de86d","name":"Get pin value","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/getpinvalue?deviceName=SystemDevice&pinName=CPU Usage","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","getpinvalue"],"query":[{"key":"deviceName","value":"SystemDevice"},{"key":"pinName","value":"CPU Usage"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:40:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"GetPinValueResult\": {\n \"PinValue\": [\n \"41.54\"\n ],\n \"ServiceStatus\": \"Success\"\n }\n}"},{"id":"e27dbb68-b410-4d15-b73f-68f91782af61","name":"Pin Not Found - Get pin value","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/getpinvalue?deviceName=SystemDevice&pinName=CPU Usage3","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","getpinvalue"],"query":[{"key":"deviceName","value":"SystemDevice"},{"key":"pinName","value":"CPU Usage3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:40:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"GetPinValueResult\": {\n \"PinValue\": null,\n \"ServiceStatus\": \"Error Calling GetPinValue: System.ServiceModel.FaultException: Error: Pin Not found:SystemDevice.CPU Usage3\\r\\n at NewCE.WCFOperations.GetPinValue(String deviceName, String pinName)\\r\\n at NewCE.WCFCommunicationREST.GetPinValue(String deviceName, String pinName)\"\n }\n}"}],"_postman_id":"6f84e0cb-af95-452c-8010-009d0b39954e"},{"name":"Set pin","id":"f446d4f1-9a33-45df-807f-b962dbf45688","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PlayerAPIHost}}/Cnario/REST/SetPin?deviceName=Speaker/HP (Realtek High Defini&pinName=WAVEOUT$Volume&pinValue=62","description":"

Sets the value of the specific PIN

\n","urlObject":{"path":["Cnario","REST","SetPin"],"host":["{{PlayerAPIHost}}"],"query":[{"key":"deviceName","value":"Speaker/HP (Realtek High Defini"},{"key":"pinName","value":"WAVEOUT$Volume"},{"key":"pinValue","value":"62"}],"variable":[]}},"response":[{"id":"b2d51794-e115-4442-8898-03c648715495","name":"Set pin","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/setpin?deviceName=Speaker/HP (Realtek High Defini&pinName=WAVEOUT$Volume&pinValue=60","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","setpin"],"query":[{"key":"deviceName","value":"Speaker/HP (Realtek High Defini"},{"key":"pinName","value":"WAVEOUT$Volume"},{"key":"pinValue","value":"60"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:37:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"SetPinResult\": {\n \"ServiceStatus\": \"Success\"\n }\n}"},{"id":"111b0442-8985-44e7-a3c5-26de88059548","name":"Value out of range - Set pin","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/setpin?deviceName=Speaker/HP (Realtek High Defini&pinName=WAVEOUT$Volume&pinValue=600","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","setpin"],"query":[{"key":"deviceName","value":"Speaker/HP (Realtek High Defini"},{"key":"pinName","value":"WAVEOUT$Volume"},{"key":"pinValue","value":"600"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:37:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"SetPinResult\": {\n \"ServiceStatus\": \"Error Calling SetPin: System.ServiceModel.FaultException: Error: Value is not within the valid value range\\r\\n at NewCE.WCFOperations.SetPin(SetPinParams[] setPinParams)\\r\\n at NewCE.WCFCommunicationREST.SetPin(String deviceName, String pinName, String pinValue)\"\n }\n}"},{"id":"4c2e2e23-0028-4a5c-9ad1-806eb5d22fff","name":"Pin not found Set pin","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{PlayerAPIHost}}/cnario/rest/setpin?deviceName=Speaker/HP (Realtek High Defini&pinName=WAVEOUT$Volume4&pinValue=600","host":["{{PlayerAPIHost}}"],"path":["cnario","rest","setpin"],"query":[{"key":"deviceName","value":"Speaker/HP (Realtek High Defini"},{"key":"pinName","value":"WAVEOUT$Volume4"},{"key":"pinValue","value":"600"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 17:38:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"SetPinResult\": {\n \"ServiceStatus\": \"Error Calling SetPin: System.ServiceModel.FaultException: Error: Pin Not found:Speaker/HP (Realtek High Defini.WAVEOUT$Volume4\\r\\n at NewCE.WCFOperations.SetPin(SetPinParams[] setPinParams)\\r\\n at NewCE.WCFCommunicationREST.SetPin(String deviceName, String pinName, String pinValue)\"\n }\n}"}],"_postman_id":"f446d4f1-9a33-45df-807f-b962dbf45688"},{"name":"Set Pins (multiple)","id":"58dbcf0b-11a9-496d-9c5c-f3acf5944891","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"setPinsParams\":\r\n [\r\n {\r\n \"DeviceName\":\"Speaker\\/HP (Realtek High Defini\",\r\n \"PinName\":\"WAVEOUT$CDAudio\",\r\n \"PinValue\":\"48\"\r\n },\r\n {\r\n \"DeviceName\":\"Speaker\\/HP (Realtek High Defini\",\r\n \"PinName\":\"WAVEOUT$Volume\",\r\n \"PinValue\":\"46\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PlayerAPIHost}}/Cnario/REST/SetPins","description":"

Sets the value of multiple PINs in multiple devices at the same time.

\n

Important note: please test that the payload size of the POST command is acceptable by the player application.

\n","urlObject":{"path":["Cnario","REST","SetPins"],"host":["{{PlayerAPIHost}}"],"query":[],"variable":[]}},"response":[{"id":"1606c656-82a3-47e7-9175-c9bcfc655e8d","name":"Set Pins","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"setPinsParams\":\r\n [\r\n {\r\n \"DeviceName\":\"Speaker\\/HP (Realtek High Defini\",\r\n \"PinName\":\"WAVEOUT$CDAudio\",\r\n \"PinValue\":\"48\"\r\n },\r\n {\r\n \"DeviceName\":\"Speaker\\/HP (Realtek High Defini\",\r\n \"PinName\":\"WAVEOUT$Volume\",\r\n \"PinValue\":\"46\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PlayerAPIHost}}/Cnario/REST/SetPins"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Request-Method","value":"POST,GET,PUT,DELETE,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,Content-Type"},{"key":"Date","value":"Fri, 13 Sep 2024 18:06:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"SetPinsResult\": {\n \"ServiceStatus\": \"Success\"\n }\n}"}],"_postman_id":"58dbcf0b-11a9-496d-9c5c-f3acf5944891"}],"id":"c0d3f43c-1026-4c66-b17f-f30bbaa9d59d","description":"

Contains all of the possible actions exposed by the Cnario Player Runtime API

\n","_postman_id":"c0d3f43c-1026-4c66-b17f-f30bbaa9d59d"}]}