API documentation Vision4K - project


Contents


  1. API documentation Vision4K - project1
  2. Vision4K device API (updated)2
  3. Get device configuration (#2493)2
  4. Report event received (#2494)3
  5. Report job completed API-calls (#2495)3
  6. Download design (#2505)4
  7. Get design data (#2506)4
  8. Report status (#2491)5
  9. Download software update (#2504)7
  10. Frontend/BMA API8
  11. CRUD V4K device (#2527)8
  12. Configuration of V4K data location (CRUD) Inst/Inst grp) (#2539)27
  13. Default network configuration (CRUD) (#2521)29
  14. WIFI network profile (CRUD) (#2541)31
  15. Designs: Get available designs (#2530)33
  16. Designs: Get Assignment Slots (Current assignment) (#2530)34
  17. Designs: Get Design Assignment Slots by id (#2530)50
  18. Designs: Get designs on installation (#2530)58
  19. Designs: Get designs on installation Group (#2530)59
  20. Designs: CRUD (#2530)59
  21. Assign vision4K (#2517)63
  22. Unassign vision4K (#2519)66
  23. Test/Helper API (updated)67
  24. Request ConfigReady  event67
  25. Request NewSlave event67
  26. Delete jobs (all) (#2586)67
  27. Delete single job (one) (#2586)67
  28. Delete all Jobs on device (related to single Vision4K) (#2586)67
  29. Ping all connected devices (#2621)68
  30. Update Available event68


Vision4K device API (updated)

Get device configuration (#2493)

URL:                 [HTTPGET] http://v4kdemo.breecesystem.com/api/configuration

HEADERS:        "content-type" must be "application/json" (preferable) or "application/xml"

                          "SerialNumber" serial number of display.

Returned JSON:

{

                    "SerialNumber": string (not nullable),

                    "InstallationId": null (default) or int,

                    "ConfigurationServer": null (default) or {

                                "Name": string (not nullable),

                                "Url": string (not nullable)

        },

                    "LanConfiguration": null (default) or {

                                "UseStaticIp": true or false (default)

                                "IpAddress": null (default) or string,

                                "Subnet": null (default) or string,

                                "Dns": null (default) or string,

                                    "Gateway": null (default) or string

        },

"WiFiConfiguration": null (default, WiFi communication disabled) or {

                    "WiFiProfile": null (default, WiFi communication disabled) or {

"ProfileName": string (not nullable),

"Ssid": string (not nullable),

"Encryption": 0 (Open, default) or 1 (WPA-PSK) or 2 (WPA-PSK2),

"PresharedKey": null (default) or string

},

"NetworkConfiguration": null (default) or {

"UseStaticIp": true or false (default)

"IpAddress": null (default) or string,

"Subnet": null (default) or string,

"Dns": null (default) or string,

"Gateway": null (default) or string

}

},

"RoleConfiguration": null (default) or {

"Role": 0 (None, default) or 1 (Master) or 2 (Slave),

"AssignedMaster": null (default) or string

"AssignedSlaves": null (default) or [{

"SerialNumber": string (not nullable),

"IpAddress": string (not nullable)

}],

},

"PresentationConfiguration": null (default) or {

"SelectedDesign": null (default) or int,

"ImageBasePath": null (default) or string,

"VideoBasePath": null (default) or string

}

}


Report event received (#2494)

MUST send job id with request if event data includes it

If there is no job ID delivered with event data, use the following API call:


URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/job/received

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display.


Returns 202 Accepted Http result code


If there is a job ID delivered with event data, use the following API call:


URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/job/[JobId]/received

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display.

Returns 202 Accepted Http result code


Report job completed API-calls (#2495)

MUST send job id with request if event data includes it

If there is no job ID included in the event data, use the following API call:

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/job/completed

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display.

Returns 202 Accepted Http result code


If there is a job ID included in the event data, use the following API call:

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/job/[JobId]/completed

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display.

Returns 202 Accepted Http result code


Download design (#2505)


URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/design

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)

Returns 200 OK with binary file data attached or 410 Gone if the download fails


Use response headers to identify attachment if necessary:

cache-control: no-cache

pragma: no-cache

content-length: 2504

content-type: text/html

expires: -1

server: Microsoft-IIS/10.0

content-disposition: attachment; filename=Design_v2.v4kd

x-aspnet-version: 4.0.30319

x-sourcefiles: =?UTF-8?B?QzpcU291cmNlXENsb3VkIEVudGVycHJpc2VcQnJlZWNlLlZpc2lvbjRLLkFwaVxhcGlcZGVzaWduXDE=?=

x-powered-by: ASP.NET

date: Thu, 21 Dec 2017 12:38:54 GMT


Get design data (#2506)

[GET] /api/designdata

HEADERS:              "content-type" must be "application/json" (preferable) or "application/xml"

                                "SerialNumber" serial number of display.


Returns 200 Ok Http Result Code

In the actual implementation it will return 403 Bad Request if there is no data available or the serial number is invalid.

Content is similar to attached example design data


SlotType will have the following meaning:

  Unknown = 0,

  Product = 1,

  Image = 2,

  Video = 3,

  Static = 4,

  Font = 5


Example images used is available here. P:\Software\Cloud\Vision4K\EksempelVisning\Images

Returns 200 OK

{

  "AssignmentSlots": {

    "VIDEO_1": {

      "SlotType": 3,

      "Value": "1Breece_Enterprise_Electronic_Shelf_Labels.mp4"

    },

    "IMAGE_1": {

      "SlotType": 2,

      "Value": "Iconbackground.png"

    },

    "IMAGE_3": {

      "SlotType": 2,

      "Value": "CompanyLogo.png"

    },

    "IMAGE_4": {

      "SlotType": 2,

      "Value": "ExtraBackground.png"

    },

    "PRODUCT_1": {

      "SlotType": 1,

      "Value": "123456789",

      "Variables": {

        "MANUFACTURERLOGO": "Logo_of_the_LG_Corporation_(1995-2008).png",

        "PRODUCTNAME": "TV OLED",

        "MODELNUMBER": "55B6V",

        "EANCODE": "123456789",

        "ARTICLENUMBER": "123456789",

        "UNITPRICE": "$1.200",

        "PROMOPRICE": "$999",

        "ICON1TEXT1": "55",

        "ICON1TEXT2": "Pollici",

        "ICON2TEXT1": "4K"

      }


Report status (#2491)


URL: [HTTPPOST] http://localhost:64092/api/status

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display.

BODY:

{

  "StatusType": 1, (1 = AssignmentStatus, 2 = MediaStatus, 3 = DeviceStatus (Not implemented yet), 4 = UpdateStatus)

  "StatusCode": 1, (1 = InProgress, 2 = Success, 3 = PartialSuccess, 4 = Failure)

  "StatusData": [XML Data (see below) or NULL]

}


RETURNS 202 ACCEPTED


ASSIGNMENT STATUS REPORTING

This report is sent from the device to the API whenever a design is downloaded and processed. In order to validate the data received, a status

report is returned to the API.

This status report needs to contain a hash of the design, as well as the slot name and hash of the value of each individual assignment slot.


XML ARCHITECTURE

<AssignmentStatus>

<DesignHash>43-B0-9B-AB-7D-5C-86-E5-81-B7-7D-D1-95-9A-DD-10-57-30-27-FA</DesignHash> (Hash of the physical design file)

<AssignmentSlots>

<Slot>

<Name>PRODUCT_1</Name>

<ValueHash>AE-FF-47-CD-93-41-3E-E5-A2-B7-7D-D1-95-9A-DD-10-57-30-27-FA</ValueHash> (As this is a product assignment, the hash is calculated from the product variables.)

</Slot>

<Slot>

<Name>IMAGE_1</Name>

<ValueHash>AE-FF-47-CD-93-41-3E-E5-A2-B7-7D-D1-95-9A-DD-10-57-30-27-FA</ValueHash> (Hash of value)

</Slot>

<Slot>

<Name>IMAGE_2</Name>

<ValueHash>AE-FF-47-CD-93-41-3E-E5-A2-B7-7D-D1-95-9A-DD-10-57-30-27-FA</ValueHash> (Hash of value)

</Slot>

</AssignmentSlots>

</AssignmentStatus>


MEDIA STATUS REPORTING

This report is sent when processing of design media files is done, like downloading videos, images, etc that are referenced.

This report needs to contain all media that required processing, a boolean flag indicating whether the processing was successful

or not. If was not successful, a message containing the reason why is also required.


XML ARCHITECTURE

<MediaStatus>

<Progress>79</Progress>(NOT IN USE YET - THIS WILL BE IGNORED)

<Media>

<Medium>

<Path>\\some\path\videos\video1.mkv</Path>

<Failed>true</Failed>

<Message>Access denied</Message>

</Medium>

<Medium>

<Path>\\some\path\images\image1.jpg</Path>

<Failed>true</Failed>

<Message>File not found</Message>

</Medium>

<Medium>

<Path>\\some\path\images\image2.jpg</Path>

<Failed>false</Failed>

<Message/>

</Medium>

</Media>

</MediaStatus>


UPDATE STATUS REPORTING

This report is sent when starting, during or ending a software update on the Vision 4K device. This report type can NOT have statuscode 3 (PartialSuccess), it is either successful, failed or in progress.


XML ARCHITECTURE

<UpdateStatus>

<Progress>79</Progress>(Progress in percent of the current software update process>

<OldVersion>1.0.0</OldVersion>(Version of the previously installed application)

<NewVersion>1.1.0</NewVersion>(Version of the application being installed)

</UpdateStatus>



Download software update (#2504)


URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/update

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to download update. (Required! broadcast events are NOT supported for now)

Returns 200 OK with binary file data attached or 410 Gone if the download fails


Use response headers to identify attachment if necessary:

cache-control: no-cache

pragma: no-cache

content-length: 2504

content-type: text/html

expires: -1

server: Microsoft-IIS/10.0

content-disposition: attachment; filename=update_v1.0.0.apk

x-aspnet-version: 4.0.30319

x-sourcefiles: =?UTF-8?B?QzpcU291cmNlXENsb3VkIEVudGVycHJpc2VcQnJlZWNlLlZpc2lvbjRLLkFwaVxhcGlcZGVzaWduXDE=?=

x-powered-by: ASP.NET

date: Thu, 21 Dec 2017 12:38:54 GMT


Frontend/BMA API

CRUD V4K device (#2527)

Create for installation:

URL: [HTTPPOST] http://demoapi.breecesystem.com/api/installations/[InstallationId]/vision4k/

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": null,

}


Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": null,

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


CREATE EXTERNAL:


URL: [HTTPPOST] http://demoapi.breecesystem.com/api/vision4k/external

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": null,

}

Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": null,

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


READ SINGLE UNREGISTERED:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}




READ SINGLE FOR INSTALLATION:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/installations/[InstallationId]/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


READ SINGLE FOR INSTALLATION GROUP:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/installationgroups/[InstallationGroupId]/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication


Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


READ SINGLE EXTERNAL:


URL: [HTTPGET] http://demoapi.breecesystem.com/api/vision4k/external/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication


Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


READ ALL UNREGISTERED:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/vision4k

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication


Returns 200 OK

{

  "Collection": [{

    "SerialNumber": "DJS000000001",

    "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

    "CreationTime": "2017-12-14T13:53:42.58",

    "FirstConnection": "2017-12-14T13:53:42.58",

    "LanUsesStaticIp": false,

    "LanIpAddress": null,

    "LanSubnet": null,

    "LanGateway": null,

    "LanDns": "8.8.8.8",

    "WiFiProfileId": null,

    "WiFiUsesStaticIp": false,

    "WiFiIpAddress": null,

    "WiFiSubnet": null,

    "WiFiGateway": null,

    "WiFiDns": null,

    "ConfigServerId": null,

    "ConfigServerName": null,

    "InstallationId": null,

    "Role": 0 (None = 0, Master = 1, Slave = 2),

    "AssignedMaster": null,

    "SelectedDesign": {

      "Id": 3,

      "FileName": "Design_v2.xml",

      "Created": "2018-01-26T14:40:02.55",

      "Changed": "2018-01-26T14:42:16.217"

    },

    "CoreVersion": "0.0.0",

    "ApplicationVersion": "0.0.0",

    "LastConnectionTime": "2018-01-05T14:40:44.227",

    "LastDisconnectTime": "2017-12-20T12:58:39.22",

    "ObjectUrl": null,

    "SelfLink": null

  }],

  "SelfLink": "http://localhost:64092/api/vision4k",

  "Pagination": {

    "PageSize": 20,

    "SkipPages": 0,

    "FilteredRecordCount": 1,

    "TotalRecordCount": 1,

    "FirstPageLink": "http://localhost:64092/api/vision4k",

    "LastPageLink": "http://localhost:64092/api/vision4k"

  }

}




READ ALL FOR INSTALLATION:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/installations/[InstallationId]/vision4k

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "Collection": [{

    "SerialNumber": "DJS000000001",

    "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

    "CreationTime": "2017-12-14T13:53:42.58",

    "FirstConnection": "2017-12-14T13:53:42.58",

    "LanUsesStaticIp": false,

    "LanIpAddress": null,

    "LanSubnet": null,

    "LanGateway": null,

    "LanDns": "8.8.8.8",

    "WiFiProfileId": null,

    "WiFiUsesStaticIp": false,

    "WiFiIpAddress": null,

    "WiFiSubnet": null,

    "WiFiGateway": null,

    "WiFiDns": null,

    "ConfigServerId": null,

    "ConfigServerName": null,

    "InstallationId": null,

    "Role": 0 (None = 0, Master = 1, Slave = 2),

    "AssignedMaster": null,

    "SelectedDesign": {

      "Id": 3,

      "FileName": "Design_v2.xml",

      "Created": "2018-01-26T14:40:02.55",

      "Changed": "2018-01-26T14:42:16.217"

    },

    "CoreVersion": "0.0.0",

    "ApplicationVersion": "0.0.0",

    "LastConnectionTime": "2018-01-05T14:40:44.227",

    "LastDisconnectTime": "2017-12-20T12:58:39.22",

    "ObjectUrl": null,

    "SelfLink": null

  }],

  "SelfLink": "http://localhost:64092/api/vision4k",

  "Pagination": {

    "PageSize": 20,

    "SkipPages": 0,

    "FilteredRecordCount": 1,

    "TotalRecordCount": 1,

    "FirstPageLink": "http://localhost:64092/api/vision4k",

    "LastPageLink": "http://localhost:64092/api/vision4k"

  }

}


READ ALL FOR INSTALLATION GROUP:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/installationgroups/[InstallationGroupId]/vision4k

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication


Returns 200 OK

{

  "Collection": [{

    "SerialNumber": "DJS000000001",

    "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

    "CreationTime": "2017-12-14T13:53:42.58",

    "FirstConnection": "2017-12-14T13:53:42.58",

    "LanUsesStaticIp": false,

    "LanIpAddress": null,

    "LanSubnet": null,

    "LanGateway": null,

    "LanDns": "8.8.8.8",

    "WiFiProfileId": null,

    "WiFiUsesStaticIp": false,

    "WiFiIpAddress": null,

    "WiFiSubnet": null,

    "WiFiGateway": null,

    "WiFiDns": null,

    "ConfigServerId": null,

    "ConfigServerName": null,

    "InstallationId": null,

    "Role": 0 (None = 0, Master = 1, Slave = 2),

    "AssignedMaster": null,

    "SelectedDesign": {

      "Id": 3,

      "FileName": "Design_v2.xml",

      "Created": "2018-01-26T14:40:02.55",

      "Changed": "2018-01-26T14:42:16.217"

    },

    "CoreVersion": "0.0.0",

    "ApplicationVersion": "0.0.0",

    "LastConnectionTime": "2018-01-05T14:40:44.227",

    "LastDisconnectTime": "2017-12-20T12:58:39.22",

    "ObjectUrl": null,

    "SelfLink": null

  }],

  "SelfLink": "http://localhost:64092/api/vision4k",

  "Pagination": {

    "PageSize": 20,

    "SkipPages": 0,

    "FilteredRecordCount": 1,

    "TotalRecordCount": 1,

    "FirstPageLink": "http://localhost:64092/api/vision4k",

    "LastPageLink": "http://localhost:64092/api/vision4k"

  }

}




READ ALL EXTERNAL:

URL: [HTTPGET] http://demoapi.breecesystem.com/api/vision4k/external

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication


Returns 200 OK

{

  "Collection": [{

    "SerialNumber": "DJS000000001",

    "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

    "CreationTime": "2017-12-14T13:53:42.58",

    "FirstConnection": "2017-12-14T13:53:42.58",

    "LanUsesStaticIp": false,

    "LanIpAddress": null,

    "LanSubnet": null,

    "LanGateway": null,

    "LanDns": "8.8.8.8",

    "WiFiProfileId": null,

    "WiFiUsesStaticIp": false,

    "WiFiIpAddress": null,

    "WiFiSubnet": null,

    "WiFiGateway": null,

    "WiFiDns": null,

    "ConfigServerId": null,

    "ConfigServerName": null,

    "InstallationId": null,

    "Role": 0 (None = 0, Master = 1, Slave = 2),

    "AssignedMaster": null,

    "SelectedDesign": {

      "Id": 3,

      "FileName": "Design_v2.xml",

      "Created": "2018-01-26T14:40:02.55",

      "Changed": "2018-01-26T14:42:16.217"

    },

    "CoreVersion": "0.0.0",

    "ApplicationVersion": "0.0.0",

    "LastConnectionTime": "2018-01-05T14:40:44.227",

    "LastDisconnectTime": "2017-12-20T12:58:39.22",

    "ObjectUrl": null,

    "SelfLink": null

  }],

  "SelfLink": "http://localhost:64092/api/vision4k",

  "Pagination": {

    "PageSize": 20,

    "SkipPages": 0,

    "FilteredRecordCount": 1,

    "TotalRecordCount": 1,

    "FirstPageLink": "http://localhost:64092/api/vision4k",

    "LastPageLink": "http://localhost:64092/api/vision4k"

  }

}


UPDATE UNREGISTERED DEVICE:

URL: [HTTPPUT] http://demoapi.breecesystem.com/api/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

    "SelectedDesign": {

        "Id": 3,

        "FileName": "Design_v2.xml",

        "Created": "2018-01-26T14:40:02.55",

        "Changed": "2018-01-26T14:42:16.217"

    },

}

Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


UPDATE INSTALLATION DEVICE:

URL: [HTTPPUT] http://demoapi.breecesystem.com/api/installations/[InstallationId]/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

    "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

}


Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


UPDATE EXTERNAL DEVICE:


URL: [HTTPPUT] http://v4kdemo.breecesystem.com/api/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

}


Returns 200 OK

{

  "SerialNumber": "DJS000000001",

  "Status": 0 (Unconfigured = 0, Configured = 1, ManagedByOtherSystem = 99),

  "CreationTime": "2017-12-14T13:53:42.58",

  "FirstConnection": "2017-12-14T13:53:42.58",

  "LanUsesStaticIp": false,

  "LanIpAddress": null,

  "LanSubnet": null,

  "LanGateway": null,

  "LanDns": "8.8.8.8",

  "WiFiProfileId": null,

  "WiFiUsesStaticIp": false,

  "WiFiIpAddress": null,

  "WiFiSubnet": null,

  "WiFiGateway": null,

  "WiFiDns": null,

  "ConfigServerId": null,

  "ConfigServerName": null,

  "InstallationId": null,

  "Role": 0 (None = 0, Master = 1, Slave = 2),

  "AssignedMaster": null,

  "SelectedDesign": {

    "Id": 3,

    "FileName": "Design_v2.xml",

    "Created": "2018-01-26T14:40:02.55",

    "Changed": "2018-01-26T14:42:16.217"

  },

  "CoreVersion": "0.0.0",

  "ApplicationVersion": "0.0.0",

  "LastConnectionTime": "2018-01-05T14:40:44.227",

  "LastDisconnectTime": "2017-12-20T12:58:39.22",

  "ObjectUrl": null,

  "SelfLink": "http://localhost:64092/api/vision4k/DJS000000001"

}


DELETE UNREGISTERED DEVICE:

URL: [HTTPDELETE] http://demoapi.breecesystem.com/api/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 204 No content Http result code


DELETE INSTALLATION DEVICE:

URL: [HTTPDELETE] http://demoapi.breecesystem.com/api/installations/[InstallationId]/vision4k/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 204 No content Http result code


DELETE EXTERNAL DEVICE:

URL: [HTTPDELETE] http://demoapi.breecesystem.com/api/vision4k/external/[SerialNumber]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 204 No content Http result code



Configuration of V4K data location (CRUD) Inst/Inst grp) (#2539)

READ FROM INSTALLATION GROUP:

URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/installationgroups/[InstallationGroupId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath1",

  "VideoBasePath": "TestPath2",

  "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}





WRITE TO INSTALLATION GROUP:

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/installationgroups/[InstallationGroupId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

    "ImageBasePath": "TestPath3",

    "VideoBasePath": "TestPath4",

  "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

}

Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath3",

  "VideoBasePath": "TestPath4",

  "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}


READ FROM INSTALLATION:

URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath1",

  "VideoBasePath": "TestPath2",

  "FontBasePath": "Testpath3",

  "DefaultBaseImage": "Testpath4",

  "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}

WRITE TO INSTALLATION:


URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

    "ImageBasePath": "TestPath3",

    "VideoBasePath": "TestPath4",

  "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5"

}


Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath3",

  "VideoBasePath": "TestPath4",

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}


Default network configuration (CRUD) (#2521)

READ FROM INSTALLATION GROUP:


URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/installationgroups/[InstallationGroupId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath1",

  "VideoBasePath": "TestPath2",

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}


WRITE TO INSTALLATION GROUP:


URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/installationgroups/[InstallationGroupId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

    "ImageBasePath": "TestPath3",

    "VideoBasePath": "TestPath4"

                                          "FontBasePath": "Testpath3",

    "DefaultBaseImage": "Testpath4",

     "DefaultBaseDownloadImage": "Testpath5",

}

Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath3",

  "VideoBasePath": "TestPath4",

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}


READ FROM INSTALLATION:


URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication


Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath1",

  "VideoBasePath": "TestPath2",

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}


WRITE TO INSTALLATION:


URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/V4KConfig

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

    "ImageBasePath": "TestPath3",

    "VideoBasePath": "TestPath4"

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

}


Returns 200 OK

{

  "ConfigId": 1,

  "ImageBasePath": "TestPath3",

  "VideoBasePath": "TestPath4",

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/V4KConfig"

}



WIFI network profile (CRUD) (#2541)

READ SINGLE:

URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/wifiprofile/[ProfileId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 200 OK

{

  "Id": 2,

  "InstallationId": 1005,

  "Name": "TestProfile2",

  "Ssid": "Wifi2",

  "Encryption": 1,

  "PresharedKey": "SomeSharedKey",

  "SelfLink": "http://localhost:64092/api/installations/1005/wifiprofile/2"

}


READ ALL:

URL: [HTTPGET] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/wifiprofile

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

    "ImageBasePath": "TestPath3",

    "VideoBasePath": "TestPath4"

   "FontBasePath": "Testpath3",

   "DefaultBaseImage": "Testpath4",

   "DefaultBaseDownloadImage": "Testpath5",

}

Returns 200 OK

{

  "Collection": [

    {

      "Id": 1,

      "InstallationId": 1005,

      "Name": "TestProfile1",

      "Ssid": "Wifi1"

    },

    {

      "Id": 2,

      "InstallationId": 1005,

      "Name": "TestProfile2",

      "Ssid": "Wifi2",

      "Encryption": 1,

      "PresharedKey": "SomeSharedKey"

    }

  ],

  "SelfLink": "http://localhost:64092/api/installations/1005/wifiprofile",

  "Pagination": {

    "PageSize": 20,

    "FilteredRecordCount": 2,

    "TotalRecordCount": 2,

    "FirstPageLink": "http://localhost:64092/api/installations/1005/wifiprofile",

    "LastPageLink": "http://localhost:64092/api/installations/1005/wifiprofile"

  }

}


WRITE WIFI PROFILE:

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/wifiprofile

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

BODY:

{

  "Id": 3 (omit or set to 0 to create new profile - only necessary when updating an existing profile),

  "InstallationId": 1005,

  "Name": "TestProfile3(Updated)",

  "Ssid": "Wifi3",

  "Encryption": 2,

  "PresharedKey": "SomeSharedKey2"

}

Returns 200 OK

{

  "Id": 3,

  "InstallationId": 1005,

  "Name": "TestProfile3(Updated)",

  "Ssid": "Wifi3",

  "Encryption": 2,

  "PresharedKey": "SomeSharedKey2",

  "SelfLink": "http://localhost:64092/api/installations/1005/wifiprofile"

}


DELETE WIFI PROFILE:

URL: [HTTPDELETE] http://v4kdemo.breecesystem.com/api/installations/[InstallationId]/wifiprofile/[ProfileId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key used for authentication

Returns 204 NO CONTENT


Designs: Get available designs (#2530)

Get available designs for an installation


URL: [HTTPGET] http://cloudapidev.breecesystem.com/api/installations/[InstallationId]/vision4k/availabledesigns

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

Returned JSON:

{

  "Collection": [{

    "Id": 1,

    "FileName": "Design_v2_keyframe.xml",

    "Created": "2018-01-15T17:35:26.42",

    "Changed": "2018-01-15T17:35:26.42",

    "InstallationId": 1005,

    "InstallationName": "Tomas    "

  }, {

    "Id": 2,

    "FileName": "Design_v2_keyframe-2.xml",

    "Created": "2018-01-15T17:42:12.737",

    "Changed": "2018-01-15T17:42:12.737",

    "InstallationId": 1005,

    "InstallationName": "Tomas    "

  }],

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/availabledesigns",

  "Pagination": {

    "PageSize": 20,

    "FilteredRecordCount": 2,

    "TotalRecordCount": 2,

    "FirstPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/availabledesigns",

    "LastPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/availabledesigns"

  }

}


Designs: Get Assignment Slots (Current assignment) (#2530)

Get current assignment including design assignment slots, their placement and value.

URL: [HTTPGET] http://cloudapidev.breecesystem.com/api/installations/[InstallationId]/vision4k/[SerialNumber]/slots

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

Returned JSON:

{

  "Collection": [{

    "SlotName": "VIDEO_1",

    "DisplayName": "Background video",

    "Elements": [{

      "Elements": [],

      "ElementId": "backgroundVideo",

      "SlotOwner": true,

      "Width": 100.0,

      "Height": 100.0

    }],

    "Value": "1Breece_Enterprise_Electronic_Shelf_Labels.mp4"

  }, {

    "SlotName": "IMAGE_1",

    "DisplayName": "Icon background",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "icon1Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon1",

        "Top": 5.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon2Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon2",

        "Top": 28.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon3Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon3",

        "Top": 51.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon4Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon4",

        "Top": 74.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon5Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon5",

        "Top": 5.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon6Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon6",

        "Top": 28.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon7Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon7",

        "Top": 51.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon8Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon8",

        "Top": 74.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }],

    "Value": "Iconbackground.png"

  }, {

    "SlotName": "IMAGE_2",

    "DisplayName": "Specs separator",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "spec1Separator",

          "SlotOwner": true,

          "Left": 10.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec2Separator",

          "SlotOwner": true,

          "Left": 20.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec3Separator",

          "SlotOwner": true,

          "Left": 30.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec4Separator",

          "SlotOwner": true,

          "Left": 40.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec5Separator",

          "SlotOwner": true,

          "Left": 50.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec6Separator",

          "SlotOwner": true,

          "Left": 60.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec7Separator",

          "SlotOwner": true,

          "Left": 70.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec8Separator",

          "SlotOwner": true,

          "Left": 80.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec9Separator",

          "SlotOwner": true,

          "Left": 90.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec10Separator",

          "SlotOwner": true,

          "Left": 99.5,

          "Width": 100.0,

          "Height": 0.5

        }],

        "ElementId": "specsContainer",

        "Top": 5.0,

        "Left": 54.0,

        "Width": 90.0,

        "Height": 30.0

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }],

    "Value": "SpecSeparator.png"

  }, {

    "SlotName": "IMAGE_3",

    "DisplayName": "Company logo",

    "Elements": [{

      "Elements": [{

        "Elements": [],

        "ElementId": "logo",

        "SlotOwner": true,

        "Top": 75.0,

        "Left": 94.0,

        "Width": 20.0,

        "Height": 4.5

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }],

    "Value": "CompanyLogo.png"

  }, {

    "SlotName": "IMAGE_4",

    "DisplayName": "Extras background",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "extrasBackground",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "extrasContainer",

        "Top": 5.0,

        "Left": 85.0,

        "Width": 50.0,

        "Height": 6.5

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }],

    "Value": "ExtraBackground.png"

  }, {

    "SlotName": "IMAGE_5",

    "DisplayName": "Promo crossover",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "promoCross",

          "SlotOwner": true,

          "Top": 70.0,

          "Left": 50.0,

          "Width": 30.0,

          "Height": 1.0

        }],

        "ElementId": "promoPriceContainer",

        "Top": 5.0,

        "Left": 14.0,

        "Width": 90.0,

        "Height": 20.0

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }],

    "Value": "PromoCrossOver.png"

  }, {

    "SlotName": "PRODUCT_1",

    "DisplayName": "Product 1",

    "Elements": [{

      "Elements": [],

      "ElementId": "descriptionContainer",

      "SlotOwner": true,

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }],

    "Value": "4000339697908"

  }],

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/DJS638592013/slots",

  "Pagination": {

    "PageSize": 20,

    "FilteredRecordCount": 7,

    "TotalRecordCount": 7,

    "FirstPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/djs638592013/slots",

    "LastPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/djs638592013/slots"

  }

}


Designs: Get Design Offline

Get designs without placement

URL: [HTTPGET] http://cloudapidev.breecesystem.com/api/installations/[InstallationId]/vision4k/designs/offline

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

Returned JSON:

{

"Collection": [

  {

"DesignId": 4,

"FileName": "Design_v2_keyframe.xml",

"CreationTime": "2018-01-18T14:42:02.31",

"LastChangeTime": "2018-01-18T14:42:02.31",

"InstallationId": 1005,

"AssignmentSlots": [

  {

"SlotId": 22,

"SlotName": "VIDEO_1",

"DisplayName": "Background video"

},

  {

"SlotId": 23,

"SlotName": "IMAGE_1",

"DisplayName": "Icon background",

"SlotPosition": 1

},

  {

"SlotId": 24,

"SlotName": "IMAGE_2",

"DisplayName": "Specs separator",

"SlotPosition": 2

},

  {

"SlotId": 25,

"SlotName": "IMAGE_3",

"DisplayName": "Company logo",

"SlotPosition": 3

},

  {

"SlotId": 26,

"SlotName": "IMAGE_4",

"DisplayName": "Extras background",

"SlotPosition": 4

},

  {

"SlotId": 27,

"SlotName": "IMAGE_5",

"DisplayName": "Promo crossover",

"SlotPosition": 5

},

  {

"SlotId": 28,

"SlotName": "PRODUCT_1",

"DisplayName": "Product 1",

"SlotPosition": 6

}

],

},

  {

"DesignId": 5,

"FileName": "Design_v2_kopi_keyframe .xml",

"CreationTime": "2018-01-18T15:17:02.01",

"LastChangeTime": "2018-01-18T15:17:02.01",

"InstallationId": 1005,

"AssignmentSlots": [

  {

"SlotId": 29,

"SlotName": "VIDEO_1",

"DisplayName": "Background video"

},

  {

"SlotId": 30,

"SlotName": "IMAGE_1",

"DisplayName": "Icon background",

"SlotPosition": 1

},

  {

"SlotId": 31,

"SlotName": "IMAGE_2",

"DisplayName": "Specs separator",

"SlotPosition": 2

},

  {

"SlotId": 32,

"SlotName": "IMAGE_3",

"DisplayName": "Company logo",

"SlotPosition": 3

},

  {

"SlotId": 33,

"SlotName": "IMAGE_4",

"DisplayName": "Extras background",

"SlotPosition": 4

},

  {

"SlotId": 34,

"SlotName": "IMAGE_5",

"DisplayName": "Promo crossover",

"SlotPosition": 5

},

  {

"SlotId": 35,

"SlotName": "PRODUCT_1",

"DisplayName": "Product 1",

"SlotPosition": 6

}

],

},

  {

"DesignId": 7,

"FileName": "martin.xml",

"CreationTime": "2018-01-25T12:01:07.187",

"LastChangeTime": "2018-01-25T12:01:07.187",

"InstallationId": 1005,

"AssignmentSlots": [

  {

"SlotId": 43,

"SlotName": "VIDEO_1",

"DisplayName": "Background video",

"AssignmentType": 3

},

  {

"SlotId": 44,

"SlotName": "IMAGE_1",

"DisplayName": "Icon background",

"AssignmentType": 2,

"SlotPosition": 1

},

  {

"SlotId": 45,

"SlotName": "IMAGE_2",

"DisplayName": "Specs separator",

"AssignmentType": 2,

"SlotPosition": 2

},

  {

"SlotId": 46,

"SlotName": "IMAGE_3",

"DisplayName": "Company logo",

"AssignmentType": 2,

"SlotPosition": 3

},

  {

"SlotId": 47,

"SlotName": "IMAGE_4",

"DisplayName": "Extras background",

"AssignmentType": 2,

"SlotPosition": 4

},

  {

"SlotId": 48,

"SlotName": "IMAGE_5",

"DisplayName": "Promo crossover",

"AssignmentType": 2,

"SlotPosition": 5

},

  {

"SlotId": 49,

"SlotName": "PRODUCT_1",

"DisplayName": "Product 1",

"AssignmentType": 1,

"SlotPosition": 6

}

],

},

  {

"DesignId": 8,

"FileName": "martin_extra.xml",

"CreationTime": "2018-01-26T13:31:58.267",

"LastChangeTime": "2018-01-26T13:31:58.267",

"InstallationId": 1005,

"AssignmentSlots": [

  {

"SlotId": 50,

"SlotName": "VIDEO_1",

"DisplayName": "Background video",

"AssignmentType": 3

},

  {

"SlotId": 51,

"SlotName": "IMAGE_1",

"DisplayName": "Icon background",

"AssignmentType": 2,

"SlotPosition": 1

},

  {

"SlotId": 52,

"SlotName": "IMAGE_2",

"DisplayName": "Specs separator",

"AssignmentType": 2,

"SlotPosition": 2

},

  {

"SlotId": 53,

"SlotName": "IMAGE_3",

"DisplayName": "Company logo",

"AssignmentType": 2,

"SlotPosition": 3

},

  {

"SlotId": 54,

"SlotName": "IMAGE_4",

"DisplayName": "Extras background",

"AssignmentType": 2,

"SlotPosition": 4

},

  {

"SlotId": 55,

"SlotName": "IMAGE_5",

"DisplayName": "Promo crossover",

"AssignmentType": 2,

"SlotPosition": 5

},

  {

"SlotId": 56,

"SlotName": "PRODUCT_1",

"DisplayName": "Product 1",

"AssignmentType": 1,

"SlotPosition": 6

},

  {

"SlotId": 57,

"SlotName": "VIDEO_2",

"DisplayName": "Background video 2",

"AssignmentType": 3,

"SlotPosition": 7

},

  {

"SlotId": 58,

"SlotName": "IMAGE_6",

"DisplayName": "Icon background 6",

"AssignmentType": 2,

"SlotPosition": 8

},

  {

"SlotId": 59,

"SlotName": "IMAGE_7",

"DisplayName": "Specs separator 7",

"AssignmentType": 2,

"SlotPosition": 9

},

  {

"SlotId": 60,

"SlotName": "IMAGE_8",

"DisplayName": "Company logo 8",

"AssignmentType": 2,

"SlotPosition": 10

},

  {

"SlotId": 61,

"SlotName": "IMAGE_9",

"DisplayName": "Extras background 9",

"AssignmentType": 2,

"SlotPosition": 11

},

  {

"SlotId": 62,

"SlotName": "IMAGE_10",

"DisplayName": "Promo crossover 10",

"AssignmentType": 2,

"SlotPosition": 12

},

  {

"SlotId": 63,

"SlotName": "PRODUCT_2",

"DisplayName": "Product 2",

"AssignmentType": 1,

"SlotPosition": 13

}

],

}

],

"SelfLink": "http://localhost:52203/api/installations/1005/vision4k/designs/offline"

}


Designs: Get Design Assignment Slots by id (#2530)

Get design assignment slots and placement by design ID

URL: [HTTPGET] http://cloudapidev.breecesystem.com/api/installations/[InstallationId]/vision4k/designs/[DesignId]/slots

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

Returned JSON:

{

  "Collection": [{

    "SlotName": "VIDEO_1",

    "DisplayName": "Background video",

    "Elements": [{

      "Elements": [],

      "ElementId": "backgroundVideo",

      "SlotOwner": true,

      "Width": 100.0,

      "Height": 100.0

    }]

  }, {

    "SlotName": "IMAGE_1",

    "DisplayName": "Icon background",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "icon1Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon1",

        "Top": 5.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon2Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon2",

        "Top": 28.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon3Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon3",

        "Top": 51.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon4Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon4",

        "Top": 74.0,

        "Left": 34.5,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon5Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon5",

        "Top": 5.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon6Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon6",

        "Top": 28.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon7Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon7",

        "Top": 51.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }, {

        "Elements": [{

          "Elements": [],

          "ElementId": "icon8Background",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "icon8",

        "Top": 74.0,

        "Left": 43.75,

        "Width": 20.0,

        "Height": 8.0

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }]

  }, {

    "SlotName": "IMAGE_2",

    "DisplayName": "Specs separator",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "spec1Separator",

          "SlotOwner": true,

          "Left": 10.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec2Separator",

          "SlotOwner": true,

          "Left": 20.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec3Separator",

          "SlotOwner": true,

          "Left": 30.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec4Separator",

          "SlotOwner": true,

          "Left": 40.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec5Separator",

          "SlotOwner": true,

          "Left": 50.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec6Separator",

          "SlotOwner": true,

          "Left": 60.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec7Separator",

          "SlotOwner": true,

          "Left": 70.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec8Separator",

          "SlotOwner": true,

          "Left": 80.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec9Separator",

          "SlotOwner": true,

          "Left": 90.0,

          "Width": 100.0,

          "Height": 0.5

        }, {

          "Elements": [],

          "ElementId": "spec10Separator",

          "SlotOwner": true,

          "Left": 99.5,

          "Width": 100.0,

          "Height": 0.5

        }],

        "ElementId": "specsContainer",

        "Top": 5.0,

        "Left": 54.0,

        "Width": 90.0,

        "Height": 30.0

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }]

  }, {

    "SlotName": "IMAGE_3",

    "DisplayName": "Company logo",

    "Elements": [{

      "Elements": [{

        "Elements": [],

        "ElementId": "logo",

        "SlotOwner": true,

        "Top": 75.0,

        "Left": 94.0,

        "Width": 20.0,

        "Height": 4.5

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }]

  }, {

    "SlotName": "IMAGE_4",

    "DisplayName": "Extras background",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "extrasBackground",

          "SlotOwner": true,

          "Width": 100.0,

          "Height": 100.0

        }],

        "ElementId": "extrasContainer",

        "Top": 5.0,

        "Left": 85.0,

        "Width": 50.0,

        "Height": 6.5

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }]

  }, {

    "SlotName": "IMAGE_5",

    "DisplayName": "Promo crossover",

    "Elements": [{

      "Elements": [{

        "Elements": [{

          "Elements": [],

          "ElementId": "promoCross",

          "SlotOwner": true,

          "Top": 70.0,

          "Left": 50.0,

          "Width": 30.0,

          "Height": 1.0

        }],

        "ElementId": "promoPriceContainer",

        "Top": 5.0,

        "Left": 14.0,

        "Width": 90.0,

        "Height": 20.0

      }],

      "ElementId": "descriptionContainer",

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }]

  }, {

    "SlotName": "PRODUCT_1",

    "DisplayName": "Product 1",

    "Elements": [{

      "Elements": [],

      "ElementId": "descriptionContainer",

      "SlotOwner": true,

      "Top": 80.0,

      "Width": 20.0,

      "Height": 100.0

    }]

  }],

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/designs/1/slots",

  "Pagination": {

    "PageSize": 20,

    "FilteredRecordCount": 7,

    "TotalRecordCount": 7,

    "FirstPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/designs/1/slots",

    "LastPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/designs/1/slots"

  }

}


Designs: Get designs on installation (#2530)

Get designs for installation API-call  

URL: [HTTPGET] http://cloudapidev.breecesystem.com/api/installations/[InstallationId]/vision4k/designs

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

Returned JSON:

{

  "Collection": [{

    "Id": 1,

    "FileName": "Design_v2_keyframe.xml",

    "Created": "2018-01-15T17:35:26.42",

    "Changed": "2018-01-15T17:35:26.42",

    "InstallationId": 1005,

    "InstallationName": "Tomas    "

  }, {

    "Id": 2,

    "FileName": "Design_v2_keyframe-2.xml",

    "Created": "2018-01-15T17:42:12.737",

    "Changed": "2018-01-15T17:42:12.737",

    "InstallationId": 1005,

    "InstallationName": "Tomas    "

    "IsLandscape": true

  }],

  "SelfLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/designs",

  "Pagination": {

    "PageSize": 20,

    "FilteredRecordCount": 2,

    "TotalRecordCount": 2,

    "FirstPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/designs",

    "LastPageLink": "http://cloudapidev.breecesystem.com/api/installations/1005/vision4k/designs"

  }

}


Designs: Get designs on installation Group (#2530)


URL: [HTTPGET] http://localhost:64092/api/installationGroups/[InstallationGroupId]/vision4k/designs

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

Returned JSON:

{

"Collection": [

{

"Id": 1,

"FileName": "DummyFile.v4kd",

"Created": "2017-12-08T19:35:04.3052034+01:00",

"Changed": "2017-12-21T05:35:04.3052034+01:00",

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true

}],

"SelfLink": "http://localhost:64092/api/installationGroups/1/vision4k/designs"

}


Designs: CRUD (#2530)

Upload design for installation

URL: [HTTPPOST] http://localhost:64092/api/installations/[InstallationId]/vision4k/designs

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

BODY:

{

"FileName": string

"EncodedDesignData": Base64 encoded byte array of zip file containing the design file

"Created": Date

"Changed": Date

"InstallationName": string

"InstallationGroupName": string

"IsLandscape": boolean

}

NOTE: EncodedDesignData is a Base64 encoded byte array containing a zipfile

Returned JSON:

{

"FileName": "TestFile.v4kd",

"EncodedDesignData": Base64 encoded byte array of zip file containing the design file

"Created": Date

"Changed": Date

"InstallationId": 1,

"InstallationName": "DummyInstallation",

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true

"SelfLink": "http://localhost:64092/api/installations/1/vision4k/designs

}


Upload design for installation group

URL: [HTTPPOST] http://localhost:64092/api/installationGroups/[InstallationGroupId]/vision4k/designs

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

BODY:

{

"FileName": string

"EncodedDesignData": Base64 encoded byte array of zip file containing the design file

"Created": Date

"Changed": Date

"InstallationGroupName": string

"IsLandscape": boolean

}


NOTE: EncodedDesignData is a Base64 encoded byte array containing a zipfile


Returned JSON:

{

"FileName": "TestFile.v4kd",

"EncodedDesignData": Base64 encoded byte array of zip file containing the design file

"Created": Date

"Changed": Date

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true

"SelfLink": "http://localhost:64092/api/installationGroups/1/vision4k/designs"

}


Download design for installation

URL: [HTTPGET] http://localhost:64092/api/installations/[InstallationId]/vision4k/designs/[DesignId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

NOTE: EncodedDesignData is a Base64 encoded byte array containing a zipfile

Returned JSON:

{

"Id": 1,

"FileName": "DummyFile.v4kd",

"EncodedDesignData": "p4aaAMk=",

"Created": "2017-12-08T20:02:14.7760505+01:00",

"Changed": "2017-12-21T06:02:14.7760505+01:00",

"InstallationId": 1,

"InstallationName": "DummyInstallation",

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true,

"SelfLink": http://localhost:64092/api/installations/1/vision4k/designs/1

}


Download design for installation (simple output)

URL: [HTTPGET] http://localhost:64092/api/installations/[InstallationId]/vision4k/designs/[DesignId]/simple

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.

NOTE: EncodedDesignData is a Base64 encoded byte array containing a zipfile

Returned JSON:

{

"Id": 1,

"FileName": "DummyFile.v4kd",

"Created": "2017-12-08T20:02:14.7760505+01:00",

"Changed": "2017-12-21T06:02:14.7760505+01:00",

"InstallationId": 1,

"InstallationName": "DummyInstallation",

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true,

"SelfLink": http://localhost:64092/api/installations/1/vision4k/designs/1

}



Download design for installation group


URL: [HTTPGET] http://localhost:64092/api/installationGroups/[InstallationGroupId]/vision4k/designs/[DesignId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.


NOTE: EncodedDesignData is a Base64 encoded byte array containing a zipfile


Returned JSON:

{

"Id": 1,

"FileName": "DummyFile.v4kd",

"EncodedDesignData": "p4aaAMk=",

"Created": "2017-12-08T20:02:14.7760505+01:00",

"Changed": "2017-12-21T06:02:14.7760505+01:00",

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true,

"SelfLink": "http://localhost:64092/api/installationGroups/1/vision4k/designs/1"

}


Download design for installation group (simple output)


URL: [HTTPGET] http://localhost:64092/api/installationGroups/[InstallationGroupId]/vision4k/designs/[DesignId]/simple

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key for authentication.


NOTE: EncodedDesignData is a Base64 encoded byte array containing a zipfile


Returned JSON:

{

"Id": 1,

"FileName": "DummyFile.v4kd",

"Created": "2017-12-08T20:02:14.7760505+01:00",

"Changed": "2017-12-21T06:02:14.7760505+01:00",

"InstallationGroupId": 1,

"InstallationGroupName": "DummyGroup",

"IsLandscape": true,

"SelfLink": "http://localhost:64092/api/installationGroups/1/vision4k/designs/1"

}



Delete design from installation

URL: [HTTPDELETE] http://localhost:64092/api/installations/[InstallationId]/vision4k/designs/[DesignId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)

Returns 204 No content Http result code


Delete design from installation group

URL: [HTTPDELETE] http://localhost:64092/api/installationGroups/[InstallationGroupId]/vision4k/designs/[DesignId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)

Returns 204 No content Http result code


Assign vision4K (#2517)


URL: [HTTPPOST] http://localhost:64092/api/installations/[InstallationId]/vision4k/[SerialNumber]/assign

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key of the user

BODY:

{

  "DesignId": 1,

  "Assignments":[

    { "SlotId": 1, "Value":"Test1"},

    { "SlotId": 2, "Value":"Test2"},

    { "SlotId": 3, "Value":"Test3"}

  ]

}


Returns

{

  "Collection": [{

    "SlotId": 1,

    "SlotName": "VIDEO_1",

    "DisplayName": "Background video",

    "AssignmentType": 3,

    "Elements": [

      {

        "Elements": [],

        "ElementId": "backgroundVideo",

        "SlotOwner": true,

        "Width": 100,

        "Height": 100

      }

    ],

    "Value": "Test1"

  },

  {

    "SlotId": 2,

    "SlotName": "IMAGE_1",

    "DisplayName": "Icon background",

    "AssignmentType": 2,

    "Elements": [

      {

        "Elements": [

          {

            "Elements": [

              {

                "Elements": [],

                "ElementId": "icon1Background",

                "SlotOwner": true,

                "Width": 100,

                "Height": 100

              }

            ],

            "ElementId": "icon1",

            "Top": 34.5,

            "Left": 5,

            "Width": 20,

            "Height": 8

          },

          {

            "Elements": [

              {

                "Elements": [],

                "ElementId": "icon2Background",

                "SlotOwner": true,

                "Width": 100,

                "Height": 100

              }

            ],

            "ElementId": "icon2",

            "Top": 34.5,

            "Left": 28,

            "Width": 20,

            "Height": 8

          },


          ......

        ],

        "ElementId": "descriptionContainer",

        "Left": 80.35,

        "Width": 19.65,

        "Height": 100

      }

    ],

    "SlotPosition": 1

  },

  {

    "SlotId": 3,

    "SlotName": "IMAGE_2",

    "DisplayName": "Specs separator",

    "AssignmentType": 2,

    "Elements": [

      {

        "Elements": [

          {

            "Elements": [

              {

                "Elements": [],

                "ElementId": "spec1Separator",

                "SlotOwner": true,

                "Top": 9,

                "Width": 100,

                "Height": 2

              },


              .....

            ],

            "ElementId": "specsContainer",

            "Top": 54,

            "Left": 5,

            "Width": 90,

            "Height": 30

          }

        ],

        "ElementId": "descriptionContainer",

        "Left": 80.35,

        "Width": 19.65,

        "Height": 100

      }

    ],

    "SlotPosition": 2

  }],

  "SelfLink": "http://localhost:64092/api/installations/1005/vision4k/DJS000000002/assign"

}


Unassign vision4K (#2519)


URL: [HTTPDELETE] http://localhost:64092/api/installations/[InstallationId]/vision4k/[SerialNumber]/assign

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"authorization-token" API key of the user


Returns 204 No Content


Test/Helper API (updated)

Request ConfigReady  event

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/test/event/configready

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)

Returns 202 Accepted Http result code


Request NewSlave event

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/test/event/newslave

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)

Returns 202 Accepted Http result code


Delete jobs (all) (#2586)

DELETE ALL JOBS:

URL: [HTTPDELETE] http://v4kdemo.breecesystem.com/api/test/jobs

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display. (Required! broadcast events are NOT supported for now)

Returns 202 Accepted


Delete single job (one) (#2586)

DELETE SINGLE JOB:

URL: [HTTPDELETE] http://v4kdemo.breecesystem.com/api/test/jobs/[JobId]

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display. (Required! broadcast events are NOT supported for now)

Returns 202 Accepted


Delete all Jobs on device (related to single Vision4K) (#2586)

DELETE ALL JOBS FOR A SPECIFIC DEVICE:

URL: [HTTPDELETE] http://v4kdemo.breecesystem.com/api/test/device/jobs

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to delete jobs for. (Required! broadcast events are NOT supported for now)

Returns 202 Accepted


Ping all connected devices (#2621)

URL: [POST] http://v4kdemo.breecesystem.com/api/test/event/pingAll

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)


Returns 200 Ok Http result code

Content is all serial numbers hit by the ping event.


Update Available event

URL: [HTTPPOST] http://v4kdemo.breecesystem.com/api/test/event/updateavailable

HEADERS:"content-type" must be "application/json" (preferable) or "application/xml"

"SerialNumber" serial number of display to receive event. (Required! broadcast events are NOT supported for now)

Returns 202 Accepted Http result code