WiPG 2100 REST API documentation - AV Distributors...28/11/2017 wePresent 2100 REST API...

28/11/2017 wePresent 2100 REST API documentation

file:///C:/Users/feres/Desktop/Develop/2K-4K%20(Curry-18days)/REST%20API/Documentation/REST_doc_w11_016/index.html 1/252

WiPG 2100 REST API documentationREST API reference document

IntroductionThis document is a reference to understand all the implemented services and resources for WiPG2100. The current document is the very first versionand some fine tuning will be done.

Representational state transfer (REST)-application programming interface (API) provides tools that allow you to manage Curry switches by in-house orthird-party system management tools. The program management environment and set of interfaces communicate directly with the third-partysystem management tools, thus avoiding the need for a dedicated network management tool. REST API simplifies network management and reducesthe number of management tools you need.

A subset of the HTTPs methods is supported by the REST API. These methods are GET, and PUT.

Document VersionVersion Author Date Notes

v0.1 Fernando Hernandez 20/7/2017 First version

v0.11 Fernando Hernandez 19/9/2017 Update with Wlan Encryption Mode and Key

v0.12 Fernando Hernandez 20/9/2017 Update with Wlan Encryption Mode and Key for root and parent nodes Wlan and Network

v0.13 Fernando Hernandez 21/9/2017 Update with Logging Url and Action new checks and outputs

v0.14 Fernando Hernandez 21/9/2017 Update removing MacAddress resource from w1.0

v0.141 Fernando Hernandez 26/9/2017 Fix Wallpapers typo in documentation

v0.142 Fernando Hernandez 28/9/2017 Update cURL commands info for Windows environments

v0.15 Fernando Hernandez 23/10/2017 Fix incorrect description for CheckCompress method



Version Author Date Notes

v0.151 Fernando Hernandez 24/10/2017 Update Resolution information and some cURL commands

v0.16 Fernando Hernandez 28/11/2017 Update with Wlan RemoteApSsid get and set

How to...There are several client tools to interact with a REST API. In these document we are going to propose two:

1. cURL ( http://curl.haxx.se/download.html [http://curl.haxx.se/download.html] ). Several examples are documented in next sections.

i. IMPORTANT NOTE: if the working environment is a Windows based one, you must wrap the admin's username and password into doublequotes, ex. curl -u "admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin" --basic -k -i -X GEThttps://base_unit_ip:4001/CurrentVersion

2. Chrome extension: Advanced REST Client( https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofdd�dnphfgcellkdfbfbjeloo[https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofdd�dnphfgcellkdfbfbjeloo] ). More intuitive.

i. IMPORTANT NOTE 1: remember to use HTTPS protocol in the URI and enabe "Use XHR" on the top bar.

ii. IMPORTANT NOTE 2: if your response shows a Network error, please, make sure you accepted the self signed certificate just running any GETmethod on your browser. It is also very important to do last step in a normal window, DON'T do that in a non chached mode like ChromeIncognito window.

SecurityThe Curry Base Unit introduced improved security features and limits REST API accessibility to the HTTPS protocol. All examples provided in thismanual are using the HTTPS protocol.

Authentication

The username to be used to access the REST API is admin . The dafault password for this user is:

epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin

http://curl.haxx.se/download.htmlhttps://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo



The wePresent REST API uses HTTPS basic authentication to prevent the username and password from being sent over the wire in clear text.

API versioningThe current version of the WiPG2100 API is w1.1. Future wePresent firmware versions might have a newer version of the API. The current version of theAPI can be retrieved using the CurrentVersion parameter.

Request:

Response:

A WiPG2100 firmware version can support multiple versions of the API. A list of supported versions can be retrieved using the SupportedVersionsparameter.

Request:

Response:

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X GET https://base_unit_ip:4001/CurrentVersion

{ "status": 200, "message": "GET successful", "data": { "key": "/CurrentVersion", "value": "w1.1" } }

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X GET https://base_unit_ip:4001/SupportedVersions

{ "status": 200, "message": "GET successful", "data": {



Slash '/' functionality at the end of the URI (GET)There is a special case that a�ect all node commands, if at the end of the GET command URI we add a slash ('/') the information we will retrieve willbe a list of leaves under that node. For example:

Request:

Response:

"key": "/SupportedVersions", "value": [ "w1.0", "w1.1" ] } }

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X GET https://base_unit_ip:4001/w1.1/Network/Wlan/

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/Network/Wlan/", "value": [ "WifiEnable", "Ssid", "BroadcastSsid", "WifiBand", "WifiMode", "Frequency", "SignalStrength", "SupportedChannels5000Mhz", "SupportedChannels2400Mhz", "Channel", "SupportedWorldRegion", "WorldRegion",



Examples. Requests using cURL commandsGetting parameters using the REST API (Linux Environment)

1. Getting a Single Parameter : A single parameter can be retrieved using the URL of a leaf node.

Request:

Response:

2. Getting a Multi Parameter : A full sub tree of a node can be retrieved using the URL of the branch node.

Request:

Response:

"MacAddress" ] } }

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X GET https://base_unit_ip:4001/w1.1/Network/Wlan/S

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/Network/Wlan/Ssid", "value": "curry-141" } }

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X GET https://base_unit_ip:4001/w1.1/Network



{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/Network", "value": { "Lan": { "MacAddress": "00:22:22:22:22:22", "GateKeeperOption": "Not Support", "DomainName": "curry-141-FERRR", "Hostname": "curry-141-FERRR", "DnsServer": "0.0.0.0", "DefaultGateway": "0.0.0.0", "IpAddress": "10.102.64.112", "IpOption": false, "SubNetmask": "0.0.0.0" }, "Wlan": { "MacAddress": "00:11:11:11:11:11", "Ssid": "curry-141-FER-6", "SupportedChannels2400mhz": [ "Auto", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11" ], "SupportedChannels5000mhz": [ "Auto", "36", "40", "44", "48", "149",



Setting Parameters using the REST API (Linux Environment)

1. Setting a Single Parameter : A single parameter can be changed using the URL of a leaf node.

Request:

Response:

"153", "157", "161" ], "SupportedWorldRegion": { "WW": "World Wide", "JP": "Japan", "US": "United States", "DE": "Europe", "CN": "China" }, "BroadcastSsid": true, "Channel": 0, "WorldRegion": "US", "SignalStrength": 100, "WifiMode": "5an", "WifiEnable": true, "Frequency": "5 GHz" } } } }

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X PUT https://base_unit_ip:4001/w1.1/Network/Wlan/S

{ "status": 200, "message": "PUT successful" }



2. Setting Multiple Parameters : It is also possible to set multiple parameters in one PUT command. To do this, the URL should correspond with thehighest common node of all leaf nodes that need to be changed. The value argument should be a json tree object. Only the parameters requiredto be changed should be provided. Request:

Response:

Getting/Setting parameters using the REST API (Windows Environment)

For Windows environments, the use of REST API client like Chrome extension commented previously, is advised because it is more simple. But cURLcommands can also be used. Note that the main di�erence is the use of double quotes ("") and escape them when they are inside the JSON string.

Prerequirement: install cURL for Windows

Open Windows commmand line (cmd) and try:

Get request:

Get Response:

curl -u admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin --basic -k -i -X PUT https://base_unit_ip:4001/w1.1/Network/Wlan -


curl -k -v -X GET --basic --user "admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin" https://base_unit_ip:4001/w1.1/ClientAcc

[...] //SOME vebosed output < HTTP/1.1 200 OK < X-Powered-By: PHP/5.6.11 < Set-Cookie: ClickShareSession=09714e9eaf7d01ea37e6ff1d82433f2e4035012f; path=/; HttpOnly



Put single param request:

Put Response:

< Expires: Thu, 19 Nov 1981 08:52:00 GMT < Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0 < Pragma: no-cache < Status: 200 OK < Content-Type: application/json; charset=utf-8 < Content-Length: 255 < Date: Thu, 28 Sep 2017 01:16:30 GMT < Server: lighttpd/1.4.41 < { "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/ClientAccess", "value": { "EnableGoogleCast": true, "EnableAirplay": true, "EnableVideoStreaming": true } } }* Connection #0 to host base_unit_ip left intact

curl -u "admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin" --basic -k -i -X PUT https://base_unit_ip:4001/w1.1/Network/Wlan

HTTP/1.1 200 OK X-Powered-By: PHP/5.6.11 Set-Cookie: ClickShareSession=e9958dfa527445b79f839743b3e30d567810595b; path=/; HttpOnly Expires: Thu, 19 Nov 1981 08:52:00 GMT Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0 Pragma: no-cache Status: 200 OK Content-Type: application/json; charset=utf-8 Content-Length: 54 Date: Thu, 28 Sep 2017 01:22:14 GMT



Put multiple params request:

Put Response:

++ REST API DOC ++

ClientAccess

Server: lighttpd/1.4.41


curl -k -v -X PUT --basic --user "admin:epevsc$9{xiq6/4>:zmIQ2t9[X74IRadmin" -d "{\"value\":{\"EnableAirplay\": true,

< HTTP/1.1 200 OK < X-Powered-By: PHP/5.6.11 < Set-Cookie: ClickShareSession=2aa898f4f0cd1fe71de6e33b10cc301913a1d921; path=/; HttpOnly < Expires: Thu, 19 Nov 1981 08:52:00 GMT < Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0 < Pragma: no-cache < Status: 200 OK < Content-Type: application/json; charset=utf-8 < Content-Length: 109 < Date: Thu, 28 Sep 2017 01:30:22 GMT < Server: lighttpd/1.4.41 < { "status": 200, "message": "PUT EnableAirplay, EnableGoogleCast, EnableVideoStreaming, successful" }* Connection #0 to host base_unit_ip left intact



ClientAccess - ClientAccess resources full info

GET

Success 200

Campo Tipo Descripción

status NumberStatus of the Response.

message StringMessage of the Response.

data jsonAll clientaccess nodes information.

Success-Response: [#success-examples-ClientAccess-ClientAccess-1_1_0-0]

Error 4xx

/w1.1/ClientAccess

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/ClientAccess", "value": { "EnableAirplay": false, "EnableGoogleCast": false, "EnableVideoStreaming": false } } }



Nombre Tipo Descripción

InfoNotFound jsonBase Unit returned empty data.

Error-Response: [#error-examples-ClientAccess-ClientAccess-1_1_0-0]

ClientAccess - ClientAccess resources full info

GET

Success 200




data jsonAll clientaccess nodes information.

Success-Response: [#success-examples-ClientAccess-ClientAccess-1_0_0-0]

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No client access info was found' }

/w1.0/ClientAccess



Error 4xx



Error-Response: [#error-examples-ClientAccess-ClientAccess-1_0_0-0]

ClientAccess - Get EnableAirplay info

GET

Success 200

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/ClientAccess", "value": { "EnableAirplay": false, "EnableVideoStreaming": false } } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No client access info was found' }

/w1.0/ClientAccess/EnableAirplay






data jsonEnableAirplay information.

Success-Response: [#success-examples-ClientAccess-EnableAirplay-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-ClientAccess-EnableAirplay-1_0_0-0]

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/ClientAccess/EnableAirplay", "value": false } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No info was found' }



ClientAccess - Get EnableGoogleCast info

GET

Success 200




data jsonEnableGoogleCast information.

Success-Response: [#success-examples-ClientAccess-EnableGoogleCast-1_1_0-0]

Error 4xx


/w1.1/ClientAccess/EnableGoogleCast

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/ClientAccess/EnableGoogleCast", "value": false } }




InfoNotFound json

Base Unit returned empty data.

Error-Response: [#error-examples-ClientAccess-EnableGoogleCast-1_1_0-0]

ClientAccess - Get EnableVideoStreaming info

GET

Success 200




data jsonEnableVideoStreaming information.


/w1.0/ClientAccess/EnableVideoStreaming



Success-Response: [#success-examples-ClientAccess-EnableVideoStreaming-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-ClientAccess-EnableVideoStreaming-1_0_0-0]

ClientAccess - Setup ClientAccess parameters

PUT

Parámetro

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/ClientAccess/EnableVideoStreaming", "value": false } }


/w1.1/ClientAccess




value jsonContains all ClientAccess parameters to be updated.

Request-Example: [#parameter-examples-ClientAccess-PutClientAccess-1_1_0-0]

Success 200




Success-Response: [#success-examples-ClientAccess-PutClientAccess-1_1_0-0]

Error 4xx


WrongData jsonWrong information passed to the base unit.

{ "EnableAirplay": false, "EnableGoogleCast": true, "EnableVideoStreaming": false }

{ "status": 200, "message": "PUT multiple params successful" }



Error-Response: [#error-examples-ClientAccess-PutClientAccess-1_1_0-0]

ClientAccess - Setup ClientAccess parameters

PUT

Parámetro


value jsonContains all ClientAccess parameters to be updated.

Request-Example: [#parameter-examples-ClientAccess-PutClientAccess-1_0_0-0]

Success 200



HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'Wrong value(s)/format passed. Check parameters name and value' }

/w1.0/ClientAccess

{ "EnableAirplay": false, "EnableVideoStreaming": false }





Success-Response: [#success-examples-ClientAccess-PutClientAccess-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-ClientAccess-PutClientAccess-1_0_0-0]

ClientAccess - Setup EnableAirplay parameter

PUT



/w1.0/ClientAccess/EnableAirplay



Parámetro


value BooleanSet EnableAirplay value.

Request-Example: [#parameter-examples-ClientAccess-PutEnableAirplay-1_0_0-0]

Success 200




Success-Response: [#success-examples-ClientAccess-PutEnableAirplay-1_0_0-0]

ClientAccess - Setup EnableGoogleCast parameter

PUT

{ "value": false, }




Parámetro


value BooleanSet EnableGoogleCast value.

Request-Example: [#parameter-examples-ClientAccess-PutEnableGoogleCast-1_1_0-0]

Success 200




Success-Response: [#success-examples-ClientAccess-PutEnableGoogleCast-1_1_0-0]

ClientAccess - Setup EnableVideoStreaming parameter

/w1.1/ClientAccess/EnableGoogleCast

{ "value": true, }




PUT

Parámetro


value BooleanSet EnableVideoStreaming value.

Request-Example: [#parameter-examples-ClientAccess-PutEnableVideoStreaming-1_0_0-0]

Success 200




Success-Response: [#success-examples-ClientAccess-PutEnableVideoStreaming-1_0_0-0]

/w1.0/ClientAccess/EnableVideoStreaming

{ "value": true, }




Conference

Conference - Conference resources full info

GET

Success 200




data jsonAll Conference nodes information. NULL nodes are not displayed here.

Success-Response: [#success-examples-Conference-Conference-1_0_0-0]

/w1.0/Conference

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Conference", "value": { "Userlist": [ { "APPType": 0, "OSType": 0,



Error 4xx



Error-Response: [#error-examples-Conference-Conference-1_0_0-0]

Conference - Get All Userlist info

GET

"id": 0, "ip": "0.0.0.0", "name": "FERES", "stream list": [ { "layout": "LAT_Default", "mirroring": "no", "stream_id": 0 } ] } ], "AllStop": true } } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No conference info was found' }



Success 200




data jsonComplete Userlist information.

Success-Response: [#success-examples-Conference-Userlist-1_0_0-0]

/w1.0/Conference/Userlist

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Conference/Userlist", "value": [ { "APPType": 0, "OSType": 0, "id": 0, "ip": "0.0.0.0", "name": "user_1", "stream list": [ { "layout": "LAT_Default", "mirroring": "no", "stream_id": 0 } ] }, {



Error 4xx



Error-Response: [#error-examples-Conference-Userlist-1_0_0-0]

Conference - Get AllStop info

GET

"APPType": 0, "OSType": 0, "id": 1, "ip": "0.0.0.0", "name": "user_2", "stream list": [ { "layout": "LAT_Default", "mirroring": "no", "stream_id": 1 } ] } ] } }




Success 200




data jsonAllStop information. True if there is no user projecting and false in the other case.

Success-Response: [#success-examples-Conference-AllStop-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Conference-AllStop-1_0_0-0]

/w1.0/Conference/AllStop

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Conference/AllStop", "value": true } }



Conference - Get Moderator info (NS)

GET

Success 200




data jsonModerator information. NULL is returned as value since this resource is not currentlysupported by this device

Success-Response: [#success-examples-Conference-Moderator-1_0_0-0]


/w1.0/Conference/Moderator

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Conference/Moderator", "value": "NULL"



Error 4xx



Error-Response: [#error-examples-Conference-Moderator-1_0_0-0]

Conference - Get user's info of selected index(user's id)

GET

Success 200




} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No moderator info was found' }

/w1.0/Conference/Userlist/[index]




data json

Userlist information. Displaying the info related to the index (user id) input in the URL.

Success-Response for input id=0: [#success-examples-Conference-GetUserlist_Index-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Conference-GetUserlist_Index-1_0_0-0]

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Conference/Userlist", "value": { "APPType": 0, "OSType": 0, "id": 0, "ip": "0.0.0.0", "name": "user_1", "stream list": [ { "layout": "LAT_Default", "mirroring": "no", "stream_id": 0 } ] } } }



Conference - Get user's ip of selected index(user's id)

GET

Success 200




data jsonUserIp information. Displaying the info related to the index (user id) input in the URL.

Success-Response for input id=2: [#success-examples-Conference-GetUserlist_Index_UserIp-1_0_0-0]


/w1.0/Conference/Userlist/[index]/UserIp

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Conference/Userlist/2/UserIp", "value": "user_name"



Error 4xx



Error-Response: [#error-examples-Conference-GetUserlist_Index_UserIp-1_0_0-0]

Conference - Get user's projecting status of selected index(user's id)

GET

Success 200




} }


/w1.1/Conference/Userlist/[index]/Projecting




data json

Projection status information. Displaying the info related to the index (user id) input inthe URL.

Success-Response for input id=2: [#success-examples-Conference-GetUserlist_Index_Projecting-1_1_0-0]

Error 4xx



Error-Response: [#error-examples-Conference-GetUserlist_Index_Projecting-1_1_0-0]

Conference - Get user's projecting status of selected index(user's id)

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/Conference/Userlist/2/Projecting", "value": "no" } }




GET

Success 200




data jsonProjection status information. Displaying the info related to the index (user id) input inthe URL.

Success-Response for input id=2: [#success-examples-Conference-GetUserlist_Index_Projecting-1_1_0-0]

Error 4xx



/w1.1/Conference/Userlist/[index]/LayOut

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/Conference/Userlist/2/LayOut", "value": "LAT_Default" } }



Error-Response: [#error-examples-Conference-GetUserlist_Index_Projecting-1_1_0-0]

Conference - Get user's username of selected index(user's id)

GET

Success 200




data jsonUsername information. Displaying the info related to the index (user id) input in theURL.

Success-Response for input id=2: [#success-examples-Conference-GetUserlist_Index_UserName-1_0_0-0]


/w1.0/Conference/Userlist/[index]/UserName

{ "status": 200, "message": "GET Successful", "data": {



Error 4xx



Error-Response: [#error-examples-Conference-GetUserlist_Index_UserName-1_0_0-0]

Conference - Setup AllStop parameter

PUT

Parámetro


value BooleanBoolean set to true if we want to stop all users currently projecting.

Request-Example: [#parameter-examples-Conference-PutAllStop-1_0_0-0]

"key": "/w1.0/Conference/Userlist/2/Username", "value": "user_name" } }


/w1.0/Conference/AllStop



Success 200




Success-Response: [#success-examples-Conference-PutAllStop-1_0_0-0]

Conference - Setup Conference parameters (NS)

PUT

Parámetro


value jsonThis resource is not supported.

{ "value": true }


/w1.0/Conference



Request-Example: [#parameter-examples-Conference-PutConference-1_0_0-0]

Success 200


status BooleanStatus of the Response.


Success-Response: [#success-examples-Conference-PutConference-1_0_0-0]

Error 4xx


NonSupported jsonThis resource is not supported.

Error-Response: [#error-examples-Conference-PutConference-1_0_0-0]

{}

{ 'status' => FALSE, 'message' => 'Single or Multiple PUT are not supported for this resource.' }

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'Single or Multiple PUT are not supported for this resource.' }



Conference - Setup UserList parameters (NS)

PUT

Parámetro



Request-Example: [#parameter-examples-Conference-PutUserList-1_0_0-0]

Success 200




Success-Response: [#success-examples-Conference-PutUserList-1_0_0-0]

/w1.0/Conference/UserList

{}

{ 'status' => FALSE, 'message' => 'This resource in w1.0 version is not supported for current device, try w1.1' }



Error 4xx



Error-Response: [#error-examples-Conference-PutUserList-1_0_0-0]

Conference - Setup conference Moderator (NS)

PUT

Parámetro


value BooleanThis resource is not supported.

Request-Example: [#parameter-examples-Conference-PutModerator-1_0_0-0]

Success 200

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'This resource in w1.0 version is not supported for current device, try w1.1' }

/w1.0/Conference/Moderator

{}






Success-Response: [#success-examples-Conference-PutModerator-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Conference-PutModerator-1_0_0-0]

Conference - Setup user's(index=id) projection layout status

PUT

{ 'status' => FALSE, 'message' => 'PUT is not supported for this resource.' }

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'PUT is not supported for this resource.' }



Parámetro


value String/Boolean"FULL" for full screen projection and "AUTO" to let the base unit arrange it.

Request-Example: [#parameter-examples-Conference-PutUserList_Layout-1_1_0-0]

Success 200




Success-Response: [#success-examples-Conference-PutUserList_Layout-1_1_0-0]

Error 4xx


/w1.1/Conference/UserList/[index]/Layout

{ "value": "FULL" }





WrongData json

Wrong information passed to the base unit.

NonAllowed jsonModeration is being blocked from OSD or Web Conference Control.

Error-Response: [#error-examples-Conference-PutUserList_Layout-1_1_0-0]Error-Response: [#error-examples-Conference-PutUserList_Layout-1_1_0-1]

Conference - Setup user's(index=id) projection status

PUT

Parámetro

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'PUT Failed. No resource defined to be modified, wrong URI and empty or wrong parameter\'s value' }

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'PUT Failed. Conference blocked from OSD or WEB' }

/w1.1/Conference/UserList/[index]/Projecting




value String/Boolean"true" to start projecting and "false" to stop it.

Request-Example: [#parameter-examples-Conference-PutUserList_Projecting-1_1_0-0]

Success 200




Success-Response: [#success-examples-Conference-PutUserList_Projecting-1_1_0-0]

Error 4xx



{ "value": "true" }





NonAllowed jsonModeration is being blocked from OSD or Web Conference Control.

Error-Response: [#error-examples-Conference-PutUserList_Projecting-1_1_0-0]Error-Response: [#error-examples-Conference-PutUserList_Projecting-1_1_0-1]

Configuration

Configuration - Put Configuration info

PUT

Error 4xx


HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'PUT Failed. Conference blocked from OSD or WEB' }

/w1.0/Configuration




NotSupported jsonBase Unit returned empty data.

Error-Response: [#error-examples-Configuration-Configuration-1_0_0-0]

Configuration - Configuration resources full info

GET

Success 200




data jsonAll configuration nodes information.

Success-Response: [#success-examples-Configuration-Configuration-1_0_0-0]

HTTP/1.1 405 Bad Request { 'status': FALSE, 'message': 'Single or Multiple PUT are not supported for this resource.' }

/w1.0/Configuration



Error 4xx



Error-Response: [#error-examples-Configuration-Configuration-1_0_0-0]

Configuration - Reset to factory

PUT

Parámetro

{ "status": 200, "message": "GET successful", "data": { "key": "/w1.0/Configuration", "value": { "Restartsystem": false, "SetAction": "No Action" } } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No configuration info was found' }

/w1.0/Configuration/SetAction




value String'Reset' will rebbot the base unit

Request-Example: [#parameter-examples-Configuration-PutSetACtion-1_0_0-0]

Success 200




Success-Response: [#success-examples-Configuration-PutSetACtion-1_0_0-0]

Error 4xx


WrongValue jsonInput value is not supported

Error-Response: [#error-examples-Configuration-PutSetACtion-1_0_0-0]

{ "value":'Reset' }

{ "status": 200, "message": "reset successful" }



Configuration - Restart system now

PUT

Parámetro


value Booleantrue will rebbot the base unit

Request-Example: [#parameter-examples-Configuration-PutRestartSystem-1_0_0-0]

Success 200



HTTP/1.1 422 Not Found { 'status': FALSE, 'message': 'Unprocessable Entity. Wrong value input' }

/w1.0/Configuration/RestartSystem

{ "value": true }





Success-Response: [#success-examples-Configuration-PutRestartSystem-1_0_0-0]

Error 4xx


WrongValue jsonInput value is not supported

Error-Response: [#error-examples-Configuration-PutRestartSystem-1_0_0-0]

Configuration - Restart system status value

GET

{ "status": 200, "message": "reboot successful" }

HTTP/1.1 422 Not Found { 'status': FALSE, 'message': 'Unprocessable Entity. Wrong value input' }

/w1.0/Configuration/RestartSystem



Success 200




data jsonRestart system status value.

Success-Response: [#success-examples-Configuration-GetRestartSystem-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Configuration-GetRestartSystem-1_0_0-0]

{ "status": 200, "message": "GET successful", "data": { "key": "/w1.0/Configuration/RestartSystem", "value": false } }

HTTP/1.1 404 Not Found { 'status': FALSE,



Configuration - Set action flag status

GET

Success 200




data jsonSetAction flag status.Currently unique, "No Action"

Success-Response: [#success-examples-Configuration-GetSetAction-1_0_0-0]

Error 4xx

'message': 'No restart system info was found' }

/w1.0/Configuration/SetAction

{ "status": 200, "message": "GET successful", "data": { "key": "/w1.0/Configuration/SetAction", "value": "No Action" } }





Error-Response: [#error-examples-Configuration-GetSetAction-1_0_0-0]

DeviceInfo

DeviceInfo - DeviceInfo resources full info

GET

Success 200



HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No set action info was found' }

/w1.0/DeviceInfo





data jsonAll DeviceInfo nodes information. NULL nodes are not displayed here.

Success-Response: [#success-examples-DeviceInfo-DeviceInfo-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-DeviceInfo-1_0_0-0]

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo", "value": { "ConferencePassword": "moderator", "ModelName": "WiCS-2100", "LoginCode": "5678", "LoginCodeOption": "Disable", "Status": 0, "StatusMessage": "OK", "ArticleNumber": "Barco_Number", "InUse": false } } }



DeviceInfo - Get ArticleNumber info

GET

Success 200




data jsonArticleNumber information (fixed value)

Success-Response: [#success-examples-DeviceInfo-ArticleNumber-1_0_0-0]

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No device info was found' }

/w1.0/DeviceInfo/ArticleNumber

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/ArticleNumber", "value": "Barco_Number"



Error 4xx



Error-Response: [#error-examples-DeviceInfo-ArticleNumber-1_0_0-0]

DeviceInfo - Get ConferencePassword info

GET

Success 200


status NumberConferencePassword of the Response.


} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No article number info was found' }

/w1.0/DeviceInfo/ConferencePassword




data json

ConferencePassword information (Fixed value)

Success-Response: [#success-examples-DeviceInfo-GetConferencePassword-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-GetConferencePassword-1_0_0-0]

DeviceInfo - Get CurrentUpTime info (N/A)

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/ConferencePassword", "value": "moderationpass" } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No conference password info was found' }



GET

Success 200




data jsonCurrentUpTime information

Success-Response: [#success-examples-DeviceInfo-CurrentUpTime-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-CurrentUpTime-1_0_0-0]

/w1.0/DeviceInfo/CurrentUpTime

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/CurrentUpTime", "value": "15" } }



DeviceInfo - Get FirmwareVersion info

GET

Success 200




data jsonFirmwareVersion information

Success-Response: [#success-examples-DeviceInfo-FirmwareVersion-1_0_0-0]

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No current up time info was found' }

/w1.0/DeviceInfo/FirmwareVersion

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/FirmwareVersion", "value": "1.0.28.341"



Error 4xx



Error-Response: [#error-examples-DeviceInfo-FirmwareVersion-1_0_0-0]

DeviceInfo - Get InUse info

GET

Success 200




} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No firmware info was found' }

/w1.0/DeviceInfo/InUse




data json

InUse information

Success-Response: [#success-examples-DeviceInfo-InUse-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-InUse-1_0_0-0]

DeviceInfo - Get LoginCode info

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/InUse", "value": false } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No in use info was found' }



GET

Success 200


status NumberLoginCode of the Response.


data jsonLoginCode information.

Success-Response: [#success-examples-DeviceInfo-LoginCode-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-LoginCode-1_0_0-0]

/w1.0/DeviceInfo/LoginCode

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/LoginCode", "value": "1234" } }



DeviceInfo - Get LoginCodeOption info

GET

Success 200


status NumberLoginCodeOption of the Response.


data jsonLoginCodeOption information.

Success-Response: [#success-examples-DeviceInfo-LoginCodeOption-1_0_0-0]

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No login code info was found' }

/w1.0/DeviceInfo/LoginCodeOption

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/LoginCodeOption", "value": "Fix"



Error 4xx



Error-Response: [#error-examples-DeviceInfo-LoginCodeOption-1_0_0-0]

DeviceInfo - Get ModelName info

GET

Success 200




} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No login code option info was found' }

/w1.0/DeviceInfo/ModelName




data json

ModelName information

Success-Response: [#success-examples-DeviceInfo-ModelName-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-ModelName-1_0_0-0]

DeviceInfo - Get Sharing info (N/A)

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/ModelName", "value": "WiPG-2100" } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No model name info was found' }



GET

Success 200




data jsonSharing information

Success-Response: [#success-examples-DeviceInfo-Sharing-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-Sharing-1_0_0-0]

/w1.0/DeviceInfo/Sharing

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/Sharing", "value": "TRUE" } }



DeviceInfo - Get Status info

GET

Success 200




data jsonStatus information (Fixed value)

Success-Response: [#success-examples-DeviceInfo-Status-1_0_0-0]

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No sharing info was found' }

/w1.0/DeviceInfo/Status

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/Status", "value": 0



Error 4xx



Error-Response: [#error-examples-DeviceInfo-Status-1_0_0-0]

DeviceInfo - Get StatusMessage info

GET

Success 200


status NumberStatusMessage of the Response.


} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No status info was found' }

/w1.0/DeviceInfo/StatusMessage




data json

StatusMessage information (Fixed value)

Success-Response: [#success-examples-DeviceInfo-StatusMessage-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-StatusMessage-1_0_0-0]

DeviceInfo - Get SystemPassword info (Restricted)

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/StatusMessage", "value": "OK" } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No status message info was found' }



GET

Success 200


status NumberSystemPassword of the Response.


data jsonSystemPassword information. Restricted information.

Success-Response: [#success-examples-DeviceInfo-SystemPassword-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-SystemPassword-1_0_0-0]

/w1.0/DeviceInfo/SystemPassword

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/SystemPassword", "value": "******" } }



DeviceInfo - Get TotalUpTime info (N/A)

GET

Success 200


status NumberTotalUpTime of the Response.


data jsonTotalUpTime information.

Success-Response: [#success-examples-DeviceInfo-TotalUpTime-1_0_0-0]

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No system password info was found. This information is restricted.' }

/w1.0/DeviceInfo/TotalUpTime

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/TotalUpTime", "value": "120"



Error 4xx



Error-Response: [#error-examples-DeviceInfo-TotalUpTime-1_0_0-0]

DeviceInfo - Get TotalUsers info (N/A)

GET

Success 200


status NumberTotalUsers of the Response.


} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No total up time info was found' }

/w1.0/DeviceInfo/TotalUsers




data json

TotalUsers information.

Success-Response: [#success-examples-DeviceInfo-TotalUsers-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-TotalUsers-1_0_0-0]

DeviceInfo - Setup ConferencePassword parameter

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DeviceInfo/TotalUsers", "value": "5" } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No total users info was found' }



PUT

Parámetro


value StringThe string that will replace previously setup password.

Request-Example: [#parameter-examples-DeviceInfo-PutConferencePassword-1_0_0-0]

Success 200




Success-Response: [#success-examples-DeviceInfo-PutConferencePassword-1_0_0-0]

/w1.0/DeviceInfo/ConferencePassword

{ "value": "12345", }




DeviceInfo - Setup DeviceInfo parameters

PUT

Parámetro


value jsonContains all DeviceInfo parameters to be updated. Supported parameters: LoginCode,LoginCodeOption, SystemPassword, ConferencePassword.

Request-Example: [#parameter-examples-DeviceInfo-PutDeviceInfo-1_0_0-0]

Success 200




/w1.0/DeviceInfo

{ "SystemPassword": { "oldPass": "12345", "newPass": "admin" }, "ConferencePassword": "moderator", "LoginCode": "1234", "LoginCodeOption": "Disable" }



Success-Response: [#success-examples-DeviceInfo-PutDeviceInfo-1_0_0-0]

Error 4xx



WrongPassword jsonWrong information to set up system password is passed.

Error-Response: [#error-examples-DeviceInfo-PutDeviceInfo-1_0_0-0]Error-Response: [#error-examples-DeviceInfo-PutDeviceInfo-1_0_0-1]

DeviceInfo - Setup LoginCode parameter



HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'Old or/and new password were not passed properly. Check format or values.' }



PUT

Parámetro


value StringString with new login code option is required.

Request-Example: [#parameter-examples-DeviceInfo-PutLoginCode-1_0_0-0]

Success 200




Success-Response: [#success-examples-DeviceInfo-PutLoginCode-1_0_0-0]

/w1.0/DeviceInfo/LoginCode

{ "value": "3456" }




DeviceInfo - Setup LoginCodeOption parameter

PUT

Parámetro


value StringString with new login code option is required.

Request-Example: [#parameter-examples-DeviceInfo-PutLoginCodeOption-1_0_0-0]

Success 200




Success-Response: [#success-examples-DeviceInfo-PutLoginCodeOption-1_0_0-0]

/w1.0/DeviceInfo/LoginCodeOption

{ "value": "Random" }




Error 4xx



Error-Response: [#error-examples-DeviceInfo-PutLoginCodeOption-1_0_0-0]

DeviceInfo - Setup SystemPassword parameter

PUT

Parámetro


value jsonTwo strings are required "oldPass" and "newPass".

Request-Example: [#parameter-examples-DeviceInfo-PutSystemPassword-1_0_0-0]

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'PUT login code option failed. Wrong value passed' }

/w1.0/DeviceInfo/SystemPassword

{ "oldPass": "12345", "newPass": "admin" }



Success 200




Success-Response: [#success-examples-DeviceInfo-PutSystemPassword-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DeviceInfo-PutSystemPassword-1_0_0-0]


HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'PUT password failed. Check required parameters and/or old password.' }



DhcpServer NS

DhcpServer_NS - Get DhcpServer resources full info (NS)

GET

Success 200




data jsonAll DhcpServer nodes information. Resource not implemented.

Success-Response: [#success-examples-DhcpServer_NS-DhcpServer-1_0_0-0]

Error 4xx

/w1.0/DhcpServer

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/DhcpServer", "value": {} } }





Error-Response: [#error-examples-DhcpServer_NS-DhcpServer-1_0_0-0]

DhcpServer_NS - Setup DhcpServer parameters (NS)

PUT

Parámetro



Request-Example: [#parameter-examples-DhcpServer_NS-PutDhcpServer-1_0_0-0]

Success 200


HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No dhcp serve info was found' }

/w1.0/DhcpServer

{}






Success-Response: [#success-examples-DhcpServer_NS-PutDhcpServer-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-DhcpServer_NS-PutDhcpServer-1_0_0-0]

Display

{ 'status' => FALSE, 'message' => 'Single or Multiple PUT are not supported for this resource.' }

HTTP/1.1 404 Not Found { 'status' => FALSE, 'message' => 'Single or Multiple PUT are not supported for this resource.' }



Display - Display resources full info

GET

Success 200




data jsonAll Display nodes information.

Success-Response: [#success-examples-Display-Display-1_0_0-0]

/w1.0/Display

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.1/Display", "value": { "OutputCount": 1, "OutputTable": { "1": { "SupportedResolutions": "0:auto, 1:720p, 2:1080p, 3:1200p", "Resolution": 0, "OutputSource": 1, "SupportedOutputSource": "1:HDMI" } } }



Error 4xx



Error-Response: [#error-examples-Display-Display-1_0_0-0]

Display - Get OutputCount info

GET

Success 200




} }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No conference info was found' }

/w1.0/Display/OutputCount




data json

OutputCount information (fixed value). There is only one output source(WiPG2100).

Success-Response: [#success-examples-Display-GetOutputCount-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Display-GetOutputCount-1_0_0-0]

Display - Get device OutputSource information of selected index(1, fixed)

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Display/OutputCount", "value": 1 } }




GET

Success 200




data jsonDevice current OutputSource information. Displaying the info related to the index (1)input in the URL.

Success-Response for input id=1(fixed and unique): [#success-examples-Display-GetOutputTable_Index_OutSource-1_0_0-0]

Error 4xx



/w1.0/Display/OutputTable/[index]/OutputSource

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Display/OutputTable/1/OutputSource", "value": 1 } }



Error-Response: [#error-examples-Display-GetOutputTable_Index_OutSource-1_0_0-0]

Display - Get device list of supported output sources information of selected index(1,fixed)

GET

Success 200




data jsonDevice supported output sources information. Displaying the info related to the index(1) input in the URL. WiPG2100 only supports one (1)

Success-Response for input id=1(fixed and unique): [#success-examples-Display-GetOutputTable_Index_SupportedOutSource-1_0_0-0]


/w1.0/Display/OutputTable/[index]/SupportedOutputSource

{ "status": 200, "message": "GET Successful",



Error 4xx



Error-Response: [#error-examples-Display-GetOutputTable_Index_SupportedOutSource-1_0_0-0]

Display - Get device list of supported resolutions information of selected index(1,fixed)

GET

Success 200


"data": { "key": "/w1.0/Display/OutputTable/1/SupportedOutputSource", "value": "1:HDMI" } }


/w1.0/Display/OutputTable/[index]/SupportedResolutions






data jsonDevice supported resolutions information. Displaying the info related to the index (1)input in the URL. WiPG2100 only supports three (auto, 720p, 1080p and 1200p)

Success-Response for input id=1(fixed and unique): [#success-examples-Display-GetOutputTable_Index_SupportedRes-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Display-GetOutputTable_Index_SupportedRes-1_0_0-0]

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Display/OutputTable/1/SupportedResolutions", "value": "0:auto, 1:720p, 2:1080p, 3:1200p" } }




Display - Get device output table information of selected index(1, fixed)

GET

Success 200




data jsonDevice output table information. Displaying the info related to the index (1) input in theURL.

Success-Response for input id=1(fixed and unique): [#success-examples-Display-GetOutputTable_Index-1_0_0-0]

/w1.0/Display/OutputTable/[index]

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Display/OutputTable/1", "value": { "SupportedResolutions": "0:auto, 1:720p, 2:1080p, 3:1200p", "Resolution": 0, "OutputSource": 1, "SupportedOutputSource": "1:HDMI" }



Error 4xx



Error-Response: [#error-examples-Display-GetOutputTable_Index-1_0_0-0]

Display - Get device resolution information of selected index(1, fixed)

GET

Success 200




} }


/w1.0/Display/OutputTable/[index]/Resolution




data json

Device current resolution information. Displaying the info related to the index (1) inputin the URL.

Success-Response for input id=1(fixed and unique): [#success-examples-Display-GetOutputTable_Index_Res-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Display-GetOutputTable_Index_Res-1_0_0-0]

Display - Setup Display parameters

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Display/OutputTable/1/Resolution", "value": 0 } }




PUT

Parámetro


value jsonContains all Display parameters to be updated. Supported params:Resolution(0=>auto,1=>720p,2=>1080p,3=>1200p) and OutputSource (1, only oneoutput for WiPG2100)

Request-Example: [#parameter-examples-Display-PutDisplay-1_0_0-0]

Success 200




Success-Response: [#success-examples-Display-PutDisplay-1_0_0-0]

/w1.0/Display

{ "Resolution": 1, "OutputSource": 1 }




Error 4xx



Error-Response: [#error-examples-Display-PutDisplay-1_0_0-0]

Display - Setup device OutputSource

PUT

Parámetro


value NumberSupported OutputSources: 1=>HDMI.

Request-Example: [#parameter-examples-Display-PutOutputTable_OutputSource-1_0_0-0]


/w1.0/Display/OutputTable/[index]/OutputSource

{ "value": 1 }



Success 200




Success-Response: [#success-examples-Display-PutOutputTable_OutputSource-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Display-PutOutputTable_OutputSource-1_0_0-0]

Display - Setup device resolution





PUT

Parámetro


value NumberSupported resolutions: 0=>auto, 1=>720p, 2=>1080p and 3=>1200p.

Request-Example: [#parameter-examples-Display-PutOutputTable_Resolution-1_0_0-0]

Success 200




Success-Response: [#success-examples-Display-PutOutputTable_Resolution-1_0_0-0]

Error 4xx

/w1.0/Display/OutputTable/[index]/Resolution

{ "value": 0 }






Error-Response: [#error-examples-Display-PutOutputTable_Resolution-1_0_0-0]

Logging

Logging - Get Action info

GET

Success 200




/w1.0/Logging/Action





data jsonAction information (fixed value)

Success-Response: [#success-examples-Logging-GetAction-1_0_0-0]

Error 4xx



Error-Response: [#error-examples-Logging-GetAction-1_0_0-0]

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Logging/Action", "value": "NoAction" } }

HTTP/1.1 404 Not Found { 'status': FALSE, 'message': 'No action info was found' }



Logging - Get Url info

GET

Success 200




data jsonUrl information (fixed value, base unit ip changes). If the package is not found theresponse will be a 404 error (Check errors section)

Success-Response: [#success-examples-Logging-GetUrl-1_0_0-0]

Error 4xx


/w1.0/Logging/Url

{ "status": 200, "message": "GET Successful", "data": { "key": "/w1.0/Logging/Url", "value": "https://baseunit_ip:4001/mirrorop/wePresent_syslog.tar.gz.enc" } }




FileNotFound jsonFile was not found in the Base Unit.


Error-Response: [#error-examples-Logging-GetUrl-1_0_0-0]Error-Response: [#error-examples-Logg

WiPG 2100 REST API documentation - AV Distributors...28/11/2017 wePresent 2100 REST API...

Documents

Transcript of WiPG 2100 REST API documentation - AV Distributors...28/11/2017 wePresent 2100 REST API...