Userful API documentation version 1.9

Terms of Service

By using the Userful APIs, you agree to the Terms of Service.

© 2016 - 2020 Userful Corporation. All rights reserved.

Getting Started

This API works for Userful 11.0, 11.1, 11.2, and 11.3 versions only.

To Interact with Userful system you need to send the API calls to http://[IP Address of your Userful host]:9000/api For example, to get the system information for a Userful host that has 192.168.123.21 IP address you will send the call as http://192.168.123.21:9000/api/system

To consume the APIs, you will need to establish an authenticated session by using /session call. The following APIs are supported in the current version.

/session

post delete

post

Login to the system with username and password, and get session id back id if success.

delete

Logs the current user out of the system, destroying the existing session, if any.

Login to the system with username and password, and get session id back id if success.

Query Parameters

  • keepLoggedIn: (boolean)

    False by default. If false, the sessionId will expire after certain amount of time. If true, it will never expire.

Body

Media type: application/json

Example:

{
  "user" : "rootuser",
  "password" : "1234"
}

HTTP status code 200

Returns information about the caller's session if the caller is authenticated.

Headers

  • Set-Cookie: required (string)

    Set session cookie if callers are browsers.

    Example:

    JSESSIONID=12345678901234567890; path=/

Body

Media type: application/json

Example:

{
  "session" : {
    "name": "JSESSIONID",
    "value": "12345678901234567890",
    "version":"0.32"
  }
}

HTTP status code 401

Returned if the login fails due to invalid credentials.

/system

get

get

Returns information about the Userful host.

get put delete

get

Returns information about the license installed on the Userful host.

put

Claim the license for the Userful host using the given activation code. It can also be used to increase the number of displays for an existing license or replace the existing license using the new activation code.

delete

Delete license from the Userful host.

get

get

Download / Backup license.

put

put

Reboot the system.

put

put

Shutdown the system.

get

get

Get the manifest

get

get

Returns the status of broadcast message, whether the message is displayed or not.

put

put

Start broadcasting. Alert level can be GREEN_LEVEL, ORANGE_LEVEL and RED_LEVEL.

put

put

Stop broadcasting.

put

put

Show display id.

put

put

Hide display id.

get

get

Get the API log file.

get put delete

get

Returns status about the Userful remote.

put

Start Userful Remote Control

delete

Stop Userful Remote Control.

get

get

Returns information about system diagnostics.

put

put

Wake monitors up from dpms sleep. (leave request body empty for all displays)

put

put

Put all monitors to dpms sleep. (leave request body empty for all displays)

get post

get

Get a list of available 3rd party packages

post

Install specific packages

Install specific packages

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

[
    "scribus",
    "tuxpaint",
    "kdegraphics",
    "vym",
    "transmission-gtk",
    "userful-sample-media-6K",
    "ibus-anthy",
    "userful-plugin-vdi-extpack-install",
    "ibus-hangul",
    "userful-test-videos-8K",
    "gtk2-immodule-xim",
    "gtk3-immodule-xim",
    "imsettings-xim",
    "ibus-libpinyin",
    "userful-plugin-dvd-player",
    "userful-test-videos-6K",
    "system-config-users",
    "gedit",
    "atril",
    "eom",
    "userful-sample-media-FullHD-60fps",
    "libreoffice-langpack-en",
    "libreoffice-calc",
    "libreoffice-langpack-fr",
    "libreoffice-langpack-es",
    "libreoffice-writer",
    "libreoffice-impress",
    "userful-test-videos-4K-60fps",
    "desktopvideo",
    "userful-sample-media-4K"
]

HTTP status code 200

Returned if request is successfully processed.

HTTP status code 401

Returned if the login fails due to invalid credentials.

post

post

submit a troubleshooting report

submit a troubleshooting report

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "name": "John Doe",
  "email": "jd@userful.com",
  "catagory": "",
  "whatDoing": "testing",
  "description": "",
  "additionalText": "sent from RESTAPI"
}

HTTP status code 200

Returned if request is successfully processed.

HTTP status code 401

Returned if the login fails due to invalid credentials.

get

get

generate and download troubleshooting report (tar.bz2)

get put

get

Returns the hostname

put

Update the hostname

get put

get

Returns system's network interfaces

put

Update one of system's network interfaces. The network will restart if settings are successfully applied.

get put

get

Check if host allows partner access through Cloud

put

Set host to allow or deny partner access through Cloud

get put

get

Get receiver devices (zero clients) assignment settings. These settings affect the UCC Settings -> Reciever Device Configuration, see that panel for further notes about behavior.

put

Set receiver devices (zero clients) assignment settings. These settings affect the UCC Settings -> Reciever Device Configuration, see that panel for further notes about behavior.

get put

get

Get the current and available time zones. These settings affect the UCC Settings -> Location, see that panel for further notes about behavior.

put

Set the current time zone. These settings affect the UCC Settings -> Location, see that panel for further notes about behavior.

get

get

(WARNING: ALPHA STATE, MAY CHANGE IN THE FUTURE)

Retrieves number that changes specifically if station assignment for mapping profiles are altered. For instance, if you configure the mapping page, and then call this API, if the number remains unchanged afterwards then the mapping page has not been altered.

Note that currently this functionality is only available current if failover groups are enabled and if the host is currently part of a failover group.

/presets

post get

post

Create, update and save a preset.

get

Returns the list of existing presets.

Create, update and save a preset.

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "name" : "preset_1"
}

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id" : "FE3DE7D3-76FF-4F13-9323-4E27E03E413B",
  "name" : "preset_1",
  "playing": true
}

HTTP status code 401

Returned if the session id is invalid or session time out.

get delete

get

Returns information about the preset specified by the given preset name.

delete

Delete a preset specified by the given preset name.

Returns information about the preset specified by the given preset name.

URI Parameters

  • name: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id" : "FE3DE7D3-76FF-4F13-9323-4E27E03E413B",
  "name" : "preset_1",
  "playing": true
}

HTTP status code 401

Returned if the session id is invalid or session time out.

Delete a preset specified by the given preset name.

URI Parameters

  • name: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested session container is not found.

put

put

Switch between presets by giving the preset name.

Switch between presets by giving the preset name.

URI Parameters

  • name: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id" : "FE3DE7D3-76FF-4F13-9323-4E27E03E413B",
  "name" : "preset_1",
  "playing": true
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested session container is not found.

get delete

get

Returns information about the preset specified by the given preset id.

delete

Delete a preset by giving a preset id.

Returns information about the preset specified by the given preset id.

URI Parameters

  • id: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id" : "FE3DE7D3-76FF-4F13-9323-4E27E03E413B",
  "name" : "preset_1",
  "playing": true
}

HTTP status code 401

Returned if the session id is invalid or session time out.

Delete a preset by giving a preset id.

URI Parameters

  • id: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested session container is not found.

put

put

Switch between presets by giving preset id.

Switch between presets by giving preset id.

URI Parameters

  • id: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id" : "FE3DE7D3-76FF-4F13-9323-4E27E03E413B",
  "name" : "preset_1",
  "playing": true
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested session container is not found.

/sources

get post delete

get

Returns the source information.

post

Create source on the Userful host.

delete

Delete the specified source.

Create source on the Userful host.

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "sourceName": "source1",
  "sourceType": "Signage Player",
  "params": [
    {
      "type": "FILE_DIR_SELECT",
      "paramName": "Playlist",
      "paramValue": "[{\"type\":\"file\",\"name\":\"/shared-files/signage/Caminandes-Gran-Dillama-2013.mp4\",\"value\":\"Caminandes-Gran-Dillama-2013.mp4\"}]"
    },
    {
      "type": "RADIO",
      "paramName": "Scaling",
      "paramValue": "outside"
    },
    {
      "type": "NUMBER",
      "paramName": "Slideshow interval",
      "paramValue": "5"
    },
    {
      "type": "CHECKBOX",
      "paramName": "Disable audio",
      "paramValue": "true"
    },
    {
      "type": "HELP",
      "paramName": "",
      "paramValue": "http://support.userful.com/Docs/Station_Mapping/Signage_Player"
    },
    {
      "type": "IMAGE_SELECT",
      "paramName": "Icon",
      "paramValue": "/usr/share/userful-plugin-signage-player/icons/MediaPlayer.png"
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Example:

{
  "sourceId" : "4080090B-76B8-4CA8-9BB4-E1356584CBB8",
  "sourceName" : "source1",
  "sourceType":"Signage Player",
  "params" : [ {
    "type" : "FILE_DIR_SELECT",
    "paramName" : "Playlist",
    "paramValue" : "[{\"type\":\"file\",\"name\":\"/shared-files/signage/Caminandes-Gran-Dillama-2013.mp4\",\"value\":\"Caminandes-Gran-Dillama-2013.mp4\"}]"
  }, {
    "type" : "RADIO",
    "paramName" : "Scaling",
    "paramValue" : "outside"
  }, {
    "type" : "NUMBER",
    "paramName" : "Slideshow interval",
    "paramValue" : "5"
  }, {
    "type" : "CHECKBOX",
    "paramName" : "Disable audio",
    "paramValue" : "true"
  }, {
    "type" : "HELP",
    "paramName" : "",
    "paramValue" : "http://support.userful.com/Docs/Station_Mapping/Signage_Player"
  }, {
    "type" : "IMAGE_SELECT",
    "paramName" : "Icon",
    "paramValue" : "/usr/share/userful-plugin-signage-player/icons/MediaPlayer.png"
  } ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 403

Returned if license does not allow source type.

HTTP status code 404

Returned if the sources information is not correct.

get delete put

get

Get source information specified by giving source id.

delete

Remove source specified by giving source id.

put

Update configuration of the specific source like source name, scaling option.

Get source information specified by giving source id.

URI Parameters

  • sourceId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "sourceId": "B732AD9E-457E-4438-84BF-3E94DAB94B44",
  "sourceName": "Signage Player",
  "sourceType": "Signage Player",
  "params": [
    {
      "type": "FILE_DIR_SELECT",
      "paramName": "Playlist",
      "paramValue": "[{\"type\":\"file\",\"name\":\"/shared-files/signage/Big Buck Bunny, Sunflower (1080p).mp4\",\"value\":\"Big Buck Bunny, Sunflower (1080p).mp4\"}]"
    },
    {
      "type": "RADIO",
      "paramName": "Scaling",
      "paramValue": "outside"
    },
    {
      "type": "NUMBER",
      "paramName": "Slideshow interval",
      "paramValue": "5"
    },
    {
      "type": "CHECKBOX",
      "paramName": "Disable audio",
      "paramValue": "true"
    },
    {
      "type": "HELP",
      "paramName": "",
      "paramValue": "http://support.userful.com/Docs/Station_Mapping/Signage_Player"
    },
    {
      "type": "IMAGE_SELECT",
      "paramName": "Icon",
      "paramValue": "/usr/share/userful-plugin-signage-player/icons/MediaPlayer.png"
    }
  ]
}

HTTP status code 401

Returned if the session id is invalid or session timeout.

Remove source specified by giving source id.

URI Parameters

  • sourceId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned with no content if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if source is not found.

Update configuration of the specific source like source name, scaling option.

URI Parameters

  • sourceId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "sourceName": "Signage Player",
  "sourceType": "Signage Player",
  "params": [
    {
      "type": "FILE_DIR_SELECT",
      "paramName": "Playlist",
      "paramValue": "[{\"type\":\"file\",\"name\":\"/shared-files/signage/Big Buck Bunny, Sunflower (1080p).mp4\",\"value\":\"Big Buck Bunny, Sunflower (1080p).mp4\"}]"
    },
    {
      "type": "RADIO",
      "paramName": "Scaling",
      "paramValue": "outside"
    },
    {
      "type": "NUMBER",
      "paramName": "Slideshow interval",
      "paramValue": "5"
    },
    {
      "type": "CHECKBOX",
      "paramName": "Disable audio",
      "paramValue": "true"
    },
    {
      "type": "HELP",
      "paramName": "",
      "paramValue": "http://support.userful.com/Docs/Station_Mapping/Signage_Player"
    },
    {
      "type": "IMAGE_SELECT",
      "paramName": "Icon",
      "paramValue": "/usr/share/userful-plugin-signage-player/icons/MediaPlayer.png"
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Example:

{
  "sourceId": "B732AD9E-457E-4438-84BF-3E94DAB94B44",
  "sourceName": "Signage Player",
  "sourceType": "Signage Player",
  "params": [
    {
      "type": "FILE_DIR_SELECT",
      "paramName": "Playlist",
      "paramValue": "[{\"type\":\"file\",\"name\":\"/shared-files/signage/Big Buck Bunny, Sunflower (1080p).mp4\",\"value\":\"Big Buck Bunny, Sunflower (1080p).mp4\"}]"
    },
    {
      "type": "RADIO",
      "paramName": "Scaling",
      "paramValue": "outside"
    },
    {
      "type": "NUMBER",
      "paramName": "Slideshow interval",
      "paramValue": "5"
    },
    {
      "type": "CHECKBOX",
      "paramName": "Disable audio",
      "paramValue": "true"
    },
    {
      "type": "HELP",
      "paramName": "",
      "paramValue": "http://support.userful.com/Docs/Station_Mapping/Signage_Player"
    },
    {
      "type": "IMAGE_SELECT",
      "paramName": "Icon",
      "paramValue": "/usr/share/userful-plugin-signage-player/icons/MediaPlayer.png"
    }
  ]
}

HTTP status code 400

Returned with error message if the body format is wrong

HTTP status code 401

Returned if the caller is not authenticated.

HTTP status code 403

Returned if license does not allow source type.

/network

get

get

Returns the list of receiver devices in the same network with the Userful host. Receiver devices with status "CONNECTED" are locked to this Userful host.

get

get

Returns information about all the usb devices available on the network station.

Returns information about all the usb devices available on the network station.

URI Parameters

  • seatId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
    "devices": [
        {
            "device_file": "/dev/bus/usb/004/001",
            "devtype": "usb_device",
            "driver": "usb",
            "is_initialized": true,
            "name": "usb4",
            "number": "4",
            "property_keys": {
                "BUSNUM": "004",
                "DEVNAME": "/dev/bus/usb/004/001",
                "DEVNUM": "001",
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4",
                "DEVTYPE": "usb_device",
                "DRIVER": "usb",
                "ID_AUTOSEAT": "1",
                "ID_AVOID_LOOP": "1",
                "ID_BUS": "usb",
                "ID_FOR_SEAT": "usb-platform-nhBC2D98001BE3",
                "ID_MODEL": "E386X_Network_USB_Host_Driver",
                "ID_MODEL_ENC": "E386X\\x20Network\\x20USB\\x20Host\\x20Driver",
                "ID_MODEL_FROM_DATABASE": "2.0 root hub",
                "ID_MODEL_ID": "0002",
                "ID_PATH": "platform-nhBC2D98001BE3",
                "ID_PATH_TAG": "platform-nhBC2D98001BE3",
                "ID_REVISION": "0404",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_SERIAL": "Linux_4.4.0-2.el7.elrepo.x86_64_nhci_hcd_E386X_Network_USB_Host_Driver_nhBC2D98001BE3",
                "ID_SERIAL_SHORT": "nhBC2D98001BE3",
                "ID_USB_INTERFACES": ":090000:",
                "ID_VENDOR": "Linux_4.4.0-2.el7.elrepo.x86_64_nhci_hcd",
                "ID_VENDOR_ENC": "Linux\\x204.4.0-2.el7.elrepo.x86_64\\x20nhci_hcd",
                "ID_VENDOR_FROM_DATABASE": "Linux Foundation",
                "ID_VENDOR_ID": "1d6b",
                "MAJOR": "189",
                "MINOR": "384",
                "PRODUCT": "1d6b/2/404",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat:seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "9/0/1",
                "USEC_INITIALIZED": "125755"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4"
        },
        {
            "devtype": "usb_interface",
            "driver": "hub",
            "is_initialized": true,
            "name": "4-0:1.0",
            "number": "0",
            "property_keys": {
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-0:1.0",
                "DEVTYPE": "usb_interface",
                "DRIVER": "hub",
                "ID_AVOID_LOOP": "1",
                "ID_MODEL_FROM_DATABASE": "2.0 root hub",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_USB_CLASS_FROM_DATABASE": "Hub",
                "ID_USB_PROTOCOL_FROM_DATABASE": "Single TT",
                "ID_VENDOR_FROM_DATABASE": "Linux Foundation",
                "INTERFACE": "9/0/0",
                "MODALIAS": "usb:v1D6Bp0002d0404dc09dsc00dp01ic09isc00ip00in00",
                "PRODUCT": "1d6b/2/404",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "9/0/1",
                "USEC_INITIALIZED": "125807"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-0:1.0"
        },
        {
            "device_file": "/dev/bus/usb/004/003",
            "devtype": "usb_device",
            "driver": "usb",
            "is_initialized": true,
            "name": "4-3",
            "number": "3",
            "property_keys": {
                "BUSNUM": "004",
                "DEVNAME": "/dev/bus/usb/004/003",
                "DEVNUM": "003",
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-3",
                "DEVTYPE": "usb_device",
                "DRIVER": "usb",
                "ID_AVOID_LOOP": "1",
                "ID_BUS": "usb",
                "ID_FOR_SEAT": "usb-platform-nhBC2D98001BE3-usb-0_3",
                "ID_MODEL": "9d01",
                "ID_MODEL_ENC": "9d01",
                "ID_MODEL_ID": "9d01",
                "ID_PATH": "platform-nhBC2D98001BE3-usb-0:3",
                "ID_PATH_TAG": "platform-nhBC2D98001BE3-usb-0_3",
                "ID_REVISION": "0400",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_SERIAL": "0424_9d01",
                "ID_USB_INTERFACES": ":ff00ff:",
                "ID_VENDOR": "0424",
                "ID_VENDOR_ENC": "0424",
                "ID_VENDOR_FROM_DATABASE": "Standard Microsystems Corp.",
                "ID_VENDOR_ID": "0424",
                "MAJOR": "189",
                "MINOR": "386",
                "PRODUCT": "424/9d01/400",
                "SUBSYSTEM": "usb",
                "TAGS": ":master-of-seat:seat:seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "255/0/255",
                "USEC_INITIALIZED": "833680",
                "XORG_DRV": "smsc"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-3"
        },
        {
            "devtype": "usb_interface",
            "driver": "usbfs",
            "is_initialized": true,
            "name": "4-3:1.0",
            "number": "0",
            "property_keys": {
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-3/4-3:1.0",
                "DEVTYPE": "usb_interface",
                "DRIVER": "usbfs",
                "ID_AVOID_LOOP": "1",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_USB_CLASS_FROM_DATABASE": "Vendor Specific Class",
                "ID_VENDOR_FROM_DATABASE": "Standard Microsystems Corp.",
                "INTERFACE": "255/0/255",
                "MODALIAS": "usb:v0424p9D01d0400dcFFdsc00dpFFicFFisc00ipFFin00",
                "PRODUCT": "424/9d01/400",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "255/0/255",
                "USEC_INITIALIZED": "839167"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-3/4-3:1.0"
        },
        {
            "device_file": "/dev/bus/usb/004/002",
            "devtype": "usb_device",
            "driver": "usb",
            "is_initialized": true,
            "name": "4-6",
            "number": "6",
            "property_keys": {
                "BUSNUM": "004",
                "DEVNAME": "/dev/bus/usb/004/002",
                "DEVNUM": "002",
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6",
                "DEVTYPE": "usb_device",
                "DRIVER": "usb",
                "ID_AVOID_LOOP": "1",
                "ID_BUS": "usb",
                "ID_MODEL": "C-Media_USB_Headphone_Set",
                "ID_MODEL_ENC": "C-Media\\x20USB\\x20Headphone\\x20Set\\x20\\x20",
                "ID_MODEL_FROM_DATABASE": "Audio Adapter",
                "ID_MODEL_ID": "000c",
                "ID_REVISION": "0100",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_SERIAL": "0d8c_C-Media_USB_Headphone_Set",
                "ID_USB_INTERFACES": ":010100:010200:",
                "ID_VENDOR": "0d8c",
                "ID_VENDOR_ENC": "0d8c",
                "ID_VENDOR_FROM_DATABASE": "C-Media Electronics, Inc.",
                "ID_VENDOR_ID": "0d8c",
                "MAJOR": "189",
                "MINOR": "385",
                "PRODUCT": "d8c/c/100",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "0/0/0",
                "USEC_INITIALIZED": "76379"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6"
        },
        {
            "devtype": "usb_interface",
            "driver": "snd-usb-audio",
            "is_initialized": true,
            "name": "4-6:1.0",
            "number": "0",
            "property_keys": {
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0",
                "DEVTYPE": "usb_interface",
                "DRIVER": "snd-usb-audio",
                "ID_AVOID_LOOP": "1",
                "ID_MODEL_FROM_DATABASE": "Audio Adapter",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_VENDOR_FROM_DATABASE": "C-Media Electronics, Inc.",
                "INTERFACE": "1/1/0",
                "MODALIAS": "usb:v0D8Cp000Cd0100dc00dsc00dp00ic01isc01ip00in00",
                "PRODUCT": "d8c/c/100",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "0/0/0",
                "USEC_INITIALIZED": "79111"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0"
        },
        {
            "is_initialized": true,
            "name": "card2",
            "number": "2",
            "property_keys": {
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2",
                "ID_BUS": "usb",
                "ID_FOR_SEAT": "sound-platform-nhBC2D98001BE3-usb-0_6_1_0",
                "ID_ID": "usb-0d8c_C-Media_USB_Headphone_Set-00-Set_1",
                "ID_MODEL": "C-Media_USB_Headphone_Set",
                "ID_MODEL_ENC": "C-Media\\x20USB\\x20Headphone\\x20Set\\x20\\x20",
                "ID_MODEL_FROM_DATABASE": "Audio Adapter",
                "ID_MODEL_ID": "000c",
                "ID_PATH": "platform-nhBC2D98001BE3-usb-0:6:1.0",
                "ID_PATH_TAG": "platform-nhBC2D98001BE3-usb-0_6_1_0",
                "ID_REVISION": "0100",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_SERIAL": "0d8c_C-Media_USB_Headphone_Set",
                "ID_TYPE": "audio",
                "ID_USB_DRIVER": "snd-usb-audio",
                "ID_USB_INTERFACES": ":010100:010200:",
                "ID_USB_INTERFACE_NUM": "00",
                "ID_VENDOR": "0d8c",
                "ID_VENDOR_ENC": "0d8c",
                "ID_VENDOR_FROM_DATABASE": "C-Media Electronics, Inc.",
                "ID_VENDOR_ID": "0d8c",
                "SOUND_FORM_FACTOR": "headphone",
                "SOUND_INITIALIZED": "1",
                "SUBSYSTEM": "sound",
                "SYSTEMD_WANTS": "sound.target",
                "TAGS": ":seat:seat-usb-platform-nhBC2D98001BE3:systemd:",
                "USEC_INITIALIZED": "212293"
            },
            "subsystem": "sound",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2"
        },
        {
            "device_file": "/dev/snd/pcmC2D0c",
            "is_initialized": true,
            "name": "pcmC2D0c",
            "property_keys": {
                "DEVNAME": "/dev/snd/pcmC2D0c",
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2/pcmC2D0c",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "MAJOR": "116",
                "MINOR": "14",
                "SUBSYSTEM": "sound",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:uaccess:",
                "USEC_INITIALIZED": "212408"
            },
            "subsystem": "sound",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2/pcmC2D0c"
        },
        {
            "device_file": "/dev/snd/pcmC2D0p",
            "is_initialized": true,
            "name": "pcmC2D0p",
            "property_keys": {
                "DEVNAME": "/dev/snd/pcmC2D0p",
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2/pcmC2D0p",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "MAJOR": "116",
                "MINOR": "13",
                "SUBSYSTEM": "sound",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:uaccess:",
                "USEC_INITIALIZED": "212365"
            },
            "subsystem": "sound",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2/pcmC2D0p"
        },
        {
            "device_file": "/dev/snd/controlC2",
            "is_initialized": true,
            "name": "controlC2",
            "number": "2",
            "property_keys": {
                "DEVLINKS": "/dev/snd/by-id/usb-0d8c_C-Media_USB_Headphone_Set-00 /dev/snd/by-path/platform-nhBC2D98001BE3-usb-0:6:1.0",
                "DEVNAME": "/dev/snd/controlC2",
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2/controlC2",
                "ID_BUS": "usb",
                "ID_MODEL": "C-Media_USB_Headphone_Set",
                "ID_MODEL_ENC": "C-Media\\x20USB\\x20Headphone\\x20Set\\x20\\x20",
                "ID_MODEL_ID": "000c",
                "ID_PATH": "platform-nhBC2D98001BE3-usb-0:6:1.0",
                "ID_PATH_TAG": "platform-nhBC2D98001BE3-usb-0_6_1_0",
                "ID_REVISION": "0100",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_SERIAL": "0d8c_C-Media_USB_Headphone_Set",
                "ID_TYPE": "audio",
                "ID_USB_DRIVER": "snd-usb-audio",
                "ID_USB_INTERFACES": ":010100:010200:",
                "ID_USB_INTERFACE_NUM": "00",
                "ID_VENDOR": "0d8c",
                "ID_VENDOR_ENC": "0d8c",
                "ID_VENDOR_ID": "0d8c",
                "MAJOR": "116",
                "MINOR": "12",
                "SUBSYSTEM": "sound",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:uaccess:",
                "USEC_INITIALIZED": "212328"
            },
            "subsystem": "sound",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.0/sound/card2/controlC2"
        },
        {
            "devtype": "usb_interface",
            "driver": "snd-usb-audio",
            "is_initialized": true,
            "name": "4-6:1.1",
            "number": "1",
            "property_keys": {
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.1",
                "DEVTYPE": "usb_interface",
                "DRIVER": "snd-usb-audio",
                "ID_AVOID_LOOP": "1",
                "ID_MODEL_FROM_DATABASE": "Audio Adapter",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_VENDOR_FROM_DATABASE": "C-Media Electronics, Inc.",
                "INTERFACE": "1/2/0",
                "MODALIAS": "usb:v0D8Cp000Cd0100dc00dsc00dp00ic01isc02ip00in01",
                "PRODUCT": "d8c/c/100",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "0/0/0",
                "USEC_INITIALIZED": "212449"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.1"
        },
        {
            "devtype": "usb_interface",
            "driver": "snd-usb-audio",
            "is_initialized": true,
            "name": "4-6:1.2",
            "number": "2",
            "property_keys": {
                "DEVPATH": "/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.2",
                "DEVTYPE": "usb_interface",
                "DRIVER": "snd-usb-audio",
                "ID_AVOID_LOOP": "1",
                "ID_MODEL_FROM_DATABASE": "Audio Adapter",
                "ID_SEAT": "seat-usb-platform-nhBC2D98001BE3",
                "ID_VENDOR_FROM_DATABASE": "C-Media Electronics, Inc.",
                "INTERFACE": "1/2/0",
                "MODALIAS": "usb:v0D8Cp000Cd0100dc00dsc00dp00ic01isc02ip00in02",
                "PRODUCT": "d8c/c/100",
                "SUBSYSTEM": "usb",
                "TAGS": ":seat-usb-platform-nhBC2D98001BE3:",
                "TYPE": "0/0/0",
                "USEC_INITIALIZED": "212477"
            },
            "subsystem": "usb",
            "sysfs_path": "/sys/devices/platform/nhBC2D98001BE3/usb4/4-6/4-6:1.2"
        }
    ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if no devices are found

get

get

Returns the information about the network device specified by giving the IP_Address.

Returns the information about the network device specified by giving the IP_Address.

URI Parameters

  • ip: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "seatId": "seat-usb-platform-nhBC2D98001C57",
  "name": "ThinGlobal MiniPoint",
  "location": "",
  "ip": "192.168.131.96",
  "mac": "bc:2d:98:00:1c:57",
  "status": "CONNECTED",
  "devices": [
    {
      "id": {
        "value": "61866171-0548-4226-8447-F58A0B68AA80"
      },
      "type": "DISPLAY",
      "vid": "0424",
      "pid": "9D01",
      "manufacturer": "",
      "model": "Generic Zero-Client",
      "serial": ""
    },
    {
      "id": {
        "value": "451A6254-ADC4-4B45-98EF-52C38641A9FD"
      },
      "type": "MEDIA_DEVICE",
      "vid": "0D8C",
      "pid": "000C",
      "manufacturer": "USB ",
      "model": "C-Media Headphone Set  ",
      "serial": ""
    }
  ],
  "model": " Generic Zero-Client",
  "firmware": "039.100"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested station network is not found.

put

put

Resets the network device specified by giving the IP_Address.

Resets the network device specified by giving the IP_Address.

URI Parameters

  • ip: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested network station is not found.

put

put

Lock a network device to the Userful host, thus changing the status to online in Control Center.

Lock a network device to the Userful host, thus changing the status to online in Control Center.

URI Parameters

  • ip: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if request successfully sent.

HTTP status code 401

Returned if the session id is invalid or session time out.

put

put

Unlock a network device from the Userful host, thus changing the status from online to available in Control Center.

Unlock a network device from the Userful host, thus changing the status from online to available in Control Center.

URI Parameters

  • ip: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if request successfully sent.

HTTP status code 401

Returned if the session id is invalid or session time out.

/displays

get

get

Returns information about the displays.

get

get

Returns information about the display specified by giving the displayId.

Returns information about the display specified by giving the displayId.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
    "displayId": 1,
    "seatId": "seat0",
    "isOnline": true,
    "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
    "isShowingWelcomeScreen": true
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested dipslay is not found.

put

put

Switch the display to other source. Source can be specified as request parameters (same as in version 1.3) or in request body

Switch the display to other source. Source can be specified as request parameters (same as in version 1.3) or in request body

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Query Parameters

  • destinationSourceId: (string)

    The destination source ID the display will switch to. One of destinationSourceId and destinationSourceName must be provided.

  • destinationSourceName: (string)

    The destination source Name the display will switch to. One of destinationSourceId and destinationSourceName must be provided.

  • isShowWelcomeScreen: (boolean)

    False by default. If false, the specified source will be started immediately. If true, display will show the welcome screen.

Body

Media type: application/json

Example:

{
	"sourceId":"ABC-123-DEF-456",
	"sourceName":"Control Room Sample"
}

HTTP status code 200

Body

Media type: application/json

Example:

{
    "displayId": 1,
    "seatId": "seat0",
    "isOnline": true,
    "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
    "isShowingWelcomeScreen": true
}

HTTP status code 400

Returned if the destinationSourceId isn't specified.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display or destination source are not found.

put

put

Play the video list on the display.

Play the video list on the display.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "videolist": [
    "/video/1.mp4",
    "/video/2.mp4"
  ],
  "queue": false,
  "repeat": false,
  "slideshowInterval": 10
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Play a specific source or the assigned source on the display (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

Play a specific source or the assigned source on the display (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
	"sourceId":"ABC-123-DEF-456",
	"sourceName":"Control Room Sample"
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Pause the display if it is playing a video source

Pause the display if it is playing a video source

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Resume the display if it was pause during playing a video source

Resume the display if it was pause during playing a video source

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Resets the display by giving the displayId. Regardless of type (On-board, USB, or Network), the specified display will reset by restarting X.

Resets the display by giving the displayId. Regardless of type (On-board, USB, or Network), the specified display will reset by restarting X.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Rewind the display by specified milliseconds if it is playing a signage source

Rewind the display by specified milliseconds if it is playing a signage source

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Fast-forward the display by specified milliseconds if it is playing a signage source

Fast-forward the display by specified milliseconds if it is playing a signage source

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 200

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Go to a specific play time on the display if it is playing a signage source

Go to a specific play time on the display if it is playing a signage source

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

get

get

Get the playing current media info of the display if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

Get the playing current media info of the display if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "filename":"/shared-files/signage/video1.mpeg",
  "totalDurationInMillliseconds": 65000,
  "currentTimeInMilliseconds": 5000
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

get put

get

Retrieve display's current and available resolutions.

put

Set the display's resolution.

Retrieve display's current and available resolutions.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
    "displayId": 3,
    "currentResolution": {
	    "width": 1920,
	    "height": 1080
	},
    "availableResolutions": [
        {
            "width": 1920,
            "height": 1080
        },
        {
            "width": 1680,
            "height": 1050
        },
        {
            "width": 1600,
            "height": 900
        },
        {
            "width": 1440,
            "height": 900
        },
        {
            "width": 1400,
            "height": 1050
        },
        {
            "width": 1280,
            "height": 1024
        },
        {
            "width": 1280,
            "height": 800
        },
        {
            "width": 1280,
            "height": 720
        },
        {
            "width": 1152,
            "height": 864
        },
        {
            "width": 1024,
            "height": 768
        },
        {
            "width": 800,
            "height": 600
        },
        {
            "width": 720,
            "height": 400
        },
        {
            "width": 640,
            "height": 480
        }
    ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the display is not found.

Set the display's resolution.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
    "width": 1920,
    "height": 1080
}

HTTP status code 200

Body

Media type: application/json

Example:

{
    "displayId": 3,
    "currentResolution": {
	    "width": 1920,
	    "height": 1080
	},
    "availableResolutions": [
        {
            "width": 1920,
            "height": 1080
        },
        {
            "width": 1680,
            "height": 1050
        },
        {
            "width": 1600,
            "height": 900
        },
        {
            "width": 1440,
            "height": 900
        },
        {
            "width": 1400,
            "height": 1050
        },
        {
            "width": 1280,
            "height": 1024
        },
        {
            "width": 1280,
            "height": 800
        },
        {
            "width": 1280,
            "height": 720
        },
        {
            "width": 1152,
            "height": 864
        },
        {
            "width": 1024,
            "height": 768
        },
        {
            "width": 800,
            "height": 600
        },
        {
            "width": 720,
            "height": 400
        },
        {
            "width": 640,
            "height": 480
        }
    ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the display is not found.

get put

get

Returns the current set tag on the given display. This is visible on an individual stand alone display in the mapping page.

put

Sets the tag on a display.

Returns the current set tag on the given display. This is visible on an individual stand alone display in the mapping page.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "displayTag":"E Hall"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display id is not found.

Sets the tag on a display.

URI Parameters

  • displayId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "displayTag":"E Hall"
}

HTTP status code 200

If the setting of the display was successful.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display id is not found.

/zones

get

get

Returns the list of existing zones.

get

get

Returns information about the zone specified by giving zone name.

Returns information about the zone specified by giving zone name.

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "isShowingWelcomeScreen": false,
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE",
  "controlDisplayId": 1,
  "zoneDisplays": [
    {
      "displayId": 1,
      "isSelected": true
    },
    {
      "displayId": 2,
      "isSelected": true
    },
    {
      "displayId": 3,
      "isSelected": false
    },
    {
      "displayId": 4,
      "isSelected": false
    }
  ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Change the zone name.

Change the zone name.

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Query Parameters

  • newZoneName: required (string)

    The new video wall zone name that will be changed into

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 400

Returned if the newZoneName isn't specified.

HTTP status code 401

Returned if the session id is invalid or session time out.

put

put

Switch the zone to other source.

Switch the zone to other source.

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Query Parameters

  • destinationSourceId: (string)

    The destination source ID the zone will switch to. One of destinationSourceId and destinationSourceName must be provided.

  • destinationSourceName: (string)

    The destination source Name the zone will switch to. One of destinationSourceId and destinationSourceName must be provided.

  • isShowWelcomeScreen: (boolean)

    False by default. If false, the specified source will be started immediately. If true, zone will show the welcome screen.

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 400

Returned if the destinationSourceName isn't specified.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone or destination source are not found.

put

put

Play the assigned source on the zone (same as playAssignedSource in v1.2).

Play the assigned source on the zone (same as playAssignedSource in v1.2).

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Play the video list on the zone specified by giving zoneId.

Play the video list on the zone specified by giving zoneId.

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "videolist": [
    "/video/1.mp4",
    "/video/2.mp4"
  ],
  "queue": false,
  "repeat": false,
  "slideshowInterval": 10
}

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Stop the playing zone.

Stop the playing zone.

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Resume the zone.

Resume the zone.

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Pause the zone

Pause the zone

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Rewind the zone by specified milliseconds

Rewind the zone by specified milliseconds

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Fast-forward the zone by specified milliseconds

Fast-forward the zone by specified milliseconds

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 200

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Go to a specific play time on the zone

Go to a specific play time on the zone

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

get

get

Get the current media info of the zone. '-1' totalDurationInMillliseconds means it's playing a non-signage source

Get the current media info of the zone. '-1' totalDurationInMillliseconds means it's playing a non-signage source

URI Parameters

  • zoneName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "filename":"/shared-files/signage/video1.mpeg",
  "totalDurationInMillliseconds": 65000,
  "currentTimeInMilliseconds": 5000
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

get

get

Returns information about the zone specified by the given videowallId.

Returns information about the zone specified by the given videowallId.

URI Parameters

  • videoWallId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zones": [
    {
      "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
      "zoneName": "video wall 1",
      "isPlaying": true,
      "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
      "isShowingWelcomeScreen": false,
      "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE",
      "controlDisplayId": 1,
      "zoneDisplays": [
        {
          "displayId": 1,
          "isSelected": true
        },
        {
          "displayId": 2,
          "isSelected": true
        },
        {
          "displayId": 3,
          "isSelected": false
        },
        {
          "displayId": 4,
          "isSelected": false
        }
      ]
    },
    {
      "zoneId": "897zf456-e869-11e5-9730-9a79f06e1235",
      "zoneName": "video wall 2",
      "isPlaying": true,
      "playingSourceId": "7S865B42-4900-4C08-A11E-F6014C81B789",
      "isShowingWelcomeScreen": false,
      "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE",
      "controlDisplayId": 3,
      "zoneDisplays": [
        {
          "displayId": 1,
          "isSelected": false
        },
        {
          "displayId": 2,
          "isSelected": false
        },
        {
          "displayId": 3,
          "isSelected": true
        },
        {
          "displayId": 4,
          "isSelected": true
        }
      ]
    }
  ]
}

HTTP status code 401

Returned if the session id is invalid or session timeout.

get

get

Returns information about the zone specified by the given zoneId.

Returns information about the zone specified by the given zoneId.

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "isShowingWelcomeScreen": false,
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE",
  "controlDisplayId": 1,
  "zoneDisplays": [
    {
      "displayId": 1,
      "isSelected": true
    },
    {
      "displayId": 2,
      "isSelected": true
    },
    {
      "displayId": 3,
      "isSelected": false
    },
    {
      "displayId": 4,
      "isSelected": false
    }
  ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Switch the zone to other source.

Switch the zone to other source.

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Query Parameters

  • destinationSourceId: (string)

    The destination source ID the zone will switch to. One of destinationSourceId and destinationSourceName must be provided.

  • destinationSourceName: (string)

    The destination source Name the zone will switch to. One of destinationSourceId and destinationSourceName must be provided.

  • isShowWelcomeScreen: (boolean)

    False by default. If false, the specified source will be started immediately. If true, zone will show the welcome screen.

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 400

Returned if the destinationSourceId isn't specified.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone or destination source are not found.

put

put

Play the source assigned to the zone (same as playAssignedSource in v1.2).

Play the source assigned to the zone (same as playAssignedSource in v1.2).

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Play the video list.

Play the video list.

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "videolist": [
    "/video/1.mp4",
    "/video/2.mp4"
  ],
  "queue": false,
  "repeat": false,
  "slideshowInterval": 10
}

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Stop the playing zone.

Stop the playing zone.

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Resume the zone.

Resume the zone.

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Pause the zone

Pause the zone

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
  "zoneName": "video wall 1",
  "isPlaying": true,
  "playingSourceId": "6B199B42-4900-4C07-A11E-F6014C81B292",
  "videowallId": "30770D86-3636-45C0-A756-19C4A607ABDE"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Rewind the zone by specified milliseconds

Rewind the zone by specified milliseconds

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Fast-forward the zone by specified milliseconds

Fast-forward the zone by specified milliseconds

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 200

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Go to a specific play time on the zone

Go to a specific play time on the zone

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

get

get

Get the currnet media info of the zone. '-1' totalDurationInMillliseconds means it's playing a non-signage source

Get the currnet media info of the zone. '-1' totalDurationInMillliseconds means it's playing a non-signage source

URI Parameters

  • zoneId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "filename":"/shared-files/signage/video1.mpeg",
  "totalDurationInMillliseconds": 65000,
  "currentTimeInMilliseconds": 5000
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

/videowalls

get

get

Returns information about all the video walls for the Userful host.

get delete

get

Returns information about the videowall specified by the given videoWallId.

delete

Delete the videowall specified by the given videowallId.

Returns information about the videowall specified by the given videoWallId.

URI Parameters

  • videoWallId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id": "30770D86-3636-45C0-A756-19C4A607ABDE",
  "canvasGeometry": {
    "width": 905.520745718542,
    "height": 249.05270973333995,
    "centerX": 452.760372859271,
    "centerY": 124.52635486666998,
    "rotationDegrees": 0
  },
  "monitors": [
    {
      "displayId": 1,
      "monitorDiagonal": {
        "lengthInMillimeter": 508
      },
      "monitorGeometry": {
        "width": 442.760372859271,
        "height": 249.05270973333995,
        "centerX": 221.3801864296355,
        "centerY": 124.52635486666998,
        "rotationDegrees": 0
      }
    },
    {
      "displayId": 2,
      "monitorDiagonal": {
        "lengthInMillimeter": 508
      },
      "monitorGeometry": {
        "width": 442.760372859271,
        "height": 249.05270973333995,
        "centerX": 684.1405592889065,
        "centerY": 124.52635486666998,
        "rotationDegrees": 0
      }
    }
  ],
  "zones": [
    {
      "zoneId": "178da782-e721-11e5-9730-9a79f06e9478",
      "zoneName": "Zone-0"
    },
    {
      "zoneId": "178da782-e721-11e5-9730-9a79f06e9479",
      "zoneName": "Zone-1"
    }
  ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested video wall is not found.

Delete the videowall specified by the given videowallId.

URI Parameters

  • videoWallId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned with no content if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested video wall is not found.

/mirrorgroups

get

get

Returns information about all the mirror groups for the Userful host.

get

get

Returns information about the mirror groups specified by the given mirrorgroupName.

Returns information about the mirror groups specified by the given mirrorgroupName.

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id": "178da782-e721-11e5-9730-9a79f06e9478",
  "name": "Mirror Group 1"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested mirror group is not found.

put

put

Play the given video list assigned to the mirror group.

Play the given video list assigned to the mirror group.

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "videolist": [
    "/video/1.mp4",
    "/video/2.mp4"
  ],
  "queue": false,
  "repeat": false,
  "slideshowInterval": 10
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested mirror group is not found.

put

put

Play a specific source or the assigned source on the mirror group (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

Play a specific source or the assigned source on the mirror group (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
	"sourceId":"ABC-123-DEF-456",
	"sourceName":"Control Room Sample"
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Pause the mirror group if it is playing a video source

Pause the mirror group if it is playing a video source

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Resume the mirror group if it was pause during playing a video source

Resume the mirror group if it was pause during playing a video source

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Rewind the mirror group by specified milliseconds if it is playing a signage source

Rewind the mirror group by specified milliseconds if it is playing a signage source

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Fast-forward the mirror group by specified milliseconds if it is playing signage source

Fast-forward the mirror group by specified milliseconds if it is playing signage source

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Go to a specific play time on the mirror group if it is playing signage source

Go to a specific play time on the mirror group if it is playing signage source

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

get

get

Get the current media info of the mirror group if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

Get the current media info of the mirror group if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

URI Parameters

  • mirrorgroupName: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "filename":"/shared-files/signage/video1.mpeg",
  "totalDurationInMillliseconds": 65000,
  "currentTimeInMilliseconds": 5000
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

get

get

Returns information about the mirror groups specified by the given mirrorgroupId.

Returns information about the mirror groups specified by the given mirrorgroupId.

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id": "178da782-e721-11e5-9730-9a79f06e9478",
  "name": "Mirror Group 1"
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested mirror group is not found.

put

put

Play the video list assigned to the mirror group.

Play the video list assigned to the mirror group.

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "videolist": [
    "/video/1.mp4",
    "/video/2.mp4"
  ],
  "queue": false,
  "repeat": false,
  "slideshowInterval": 10
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested mirror group is not found.

put

put

Play a specific source or the assigned source on the mirror group (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

Play a specific source or the assigned source on the mirror group (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
	"sourceId":"ABC-123-DEF-456",
	"sourceName":"Control Room Sample"
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Pause the mirror group if it is playing a video source

Pause the mirror group if it is playing a video source

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Resume the mirror group if it was pause during playing a video source

Resume the mirror group if it was pause during playing a video source

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested display is not found.

put

put

Rewind the mirror group by specified milliseconds if it is playing a signage source

Rewind the mirror group by specified milliseconds if it is playing a signage source

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Fast-forward the mirror group by specified milliseconds if it is playing signage source

Fast-forward the mirror group by specified milliseconds if it is playing signage source

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

put

put

Go to a specific play time on the mirror group if it is playing signage source

Go to a specific play time on the mirror group if it is playing signage source

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
  "time": 5000
}

HTTP status code 204

Returned if success

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

get

get

Get the current media info of the mirror group if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

Get the current media info of the mirror group if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

URI Parameters

  • mirrorgroupId: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
  "filename":"/shared-files/signage/video1.mpeg",
  "totalDurationInMillliseconds": 65000,
  "currentTimeInMilliseconds": 5000
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if the requested zone is not found.

/failover-group

get post delete

get

Returns information about failover group which the current Userful host belongs to.

post

If the failover-group does not exist, create and join the failover-group. Both members of the group must be sent the same request in order to form a failover group

delete

Let the Userful host exit from the current failover-group. If there is only one Userful host in the group, the group will be deleted.

If the failover-group does not exist, create and join the failover-group. Both members of the group must be sent the same request in order to form a failover group

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
    "groupname": "Test group 1",
    "systems": [
        {
            "hostname": "xx",
            "systemID": "E00-5572-09AB-6197"
        },
        {
            "hostname": "vvv",
            "systemID": "E00-75BC-5577-9694"
        }
    ],
    "autofailback": true,
    "autofailbackGracePeriodInSeconds": 300,
    "hostnameSwitching" : false
}

HTTP status code 204

Returned if success.

HTTP status code 401

Returned if the login fails due to invalid credentials.

/failover-group-v2

get post delete

get

Returns all failover settings

post

Setup failover on this system. This call fails if the system is already in a failover group. In most cases it is recommended to call /system/reboot after this call to ensure that the failover group has been activated.

delete

Let the Userful host exit from the current failover-group. If there is only one Userful host in the group, the group will be deleted.

Setup failover on this system. This call fails if the system is already in a failover group. In most cases it is recommended to call /system/reboot after this call to ensure that the failover group has been activated.

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
    "groupName": "test group 1",
    "primary": true,
    "autoFailover": true,
    "autoFailback": true,
    "autoFailbackGraceSeconds": 30,
    "useHostNameSwitching": false,
    "failoverInterface": "",
    "peerIP": "",
    "password": "secret"
}

HTTP status code 204

Returned if success.

HTTP status code 400

Returned if unable to apply failover settings. Can happen if there's already failover settings applied.

HTTP status code 401

Returned if the login fails due to invalid credentials.

/failover-group-network-settings

get post

get

Returns the current network settings used by failover, which includes network interface (blank means use system default), auto-discover peers, manually-set peer ip.

post

Specific network interface and peer discovery method. Call GET to see a list of available interfaces. Call PUT:/system/reboot afterward for the changes to take effect.

Specific network interface and peer discovery method. Call GET to see a list of available interfaces. Call PUT:/system/reboot afterward for the changes to take effect.

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
    "failoverInterface": "enp0s26u1u2",
    "autoDiscoverPeer": false,
    "peerIP": "192.168.129.97"
}

HTTP status code 200

Returned if success.

HTTP status code 401

Returned if the login fails due to invalid credentials.

/printprofiles

post get

post

update print profile with the same queue name or create new print profile

get

Returns list of print profiles.

update print profile with the same queue name or create new print profile

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{
    "printProfiles": [
        {
            "isGlobal": true,
            "queueName": "global",
            "print_dialog": true,
            "cost_per_page": 1,
            "free_pages_per_session": 25,
            "session_page_limit": 100,
            "release_jobs": true,
            "show_text_entry": false,
            "text_entry_label": "Enter text",
            "max_entry_chars": 20,
            "min_entry_chars": 3,
            "printer_invoice_procedures": "noreceipt",
            "color_page_count_plural_message": "You are about to print {number} color pages.",
            "color_page_count_singular_message": "You are about to print 1 color page.",
            "dialog_title": "Would you like to print?",
            "exceed_total_page_count_message": "This print job exceeds the amount of pages left in the session. Print job cancelled.",
            "failed_page_count_accounting_message": "Cancelling job since page accounting is enabled.",
            "failed_page_count_message": "Unable to determine number of pages.",
            "free_page_count_plural_message": "You will have {number} free pages left after this print job.",
            "free_page_count_singular_message": "You will have 1 free page left after this print job.",
            "other_dialog_title": "Userful Printing",
            "page_cost_message": "The cost is {price}.",
            "page_count_plural_message": "You are about to print {number} pages.",
            "page_count_singular_message": "You are about to print 1 page.",
            "print_receipt_checkbox_label": "Print Receipt",
            "total_page_count_plural_message": "You will only be able to print {number} pages after this print job.",
            "costPerPage": 1,
            "textEntryLabel": "Enter text",
            "printReceiptCheckboxLabel": "Print Receipt",
            "freePageCountSingularMessage": "You will have 1 free page left after this print job.",
            "maxEntryChars": 20,
            "exceedTotalPageCountMessage": "This print job exceeds the amount of pages left in the session. Print job cancelled.",
            "showDialog": true,
            "failedPageCountAccountingMessage": "Cancelling job since page accounting is enabled.",
            "colorPageCountSingularMessage": "You are about to print 1 color page.",
            "totalPageCountPluralMessage": "You will only be able to print {number} pages after this print job.",
            "failedPageCountMessage": "Unable to determine number of pages.",
            "dialogTitle": "Would you like to print?",
            "colorPageCountPluralMessage": "You are about to print {number} color pages.",
            "pageCountPluralMessage": "You are about to print {number} pages.",
            "global": true,
            "pageCountSingularMessage": "You are about to print 1 page.",
            "freePageCountPluralMessage": "You will have {number} free pages left after this print job.",
            "pageCostMessage": "The cost is {price}.",
            "printInvoiceProcedure": "noreceipt",
            "freePages": 25,
            "pageLimit": 100,
            "otherDialogTitle": "Userful Printing",
            "minEntryChars": 3,
            "autoReleaseJob": true,
            "showTextEntry": false
        },
        {
            "isGlobal": false,
            "queueName": "printer1",
            "print_dialog": false,
            "release_jobs": true,
            "show_text_entry": false,
            "showDialog": false,
            "global": false,
            "autoReleaseJob": true,
            "showTextEntry": false
        }
    ]
}

HTTP status code 200

Returned if success.

HTTP status code 400

Returned if cron expression or cron job detail is invalid.

HTTP status code 401

Returned if the session id is invalid or session time out.

get delete

get

Return print profiles with specified queue name

delete

delete print profiles with specified queue name

Return print profiles with specified queue name

URI Parameters

  • queuename: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Body

Media type: application/json

Example:

{
    "printProfiles": [
        {
            "isGlobal": true,
            "queueName": "global",
            "print_dialog": true,
            "cost_per_page": 1,
            "free_pages_per_session": 25,
            "session_page_limit": 100,
            "release_jobs": true,
            "show_text_entry": false,
            "text_entry_label": "Enter text",
            "max_entry_chars": 20,
            "min_entry_chars": 3,
            "printer_invoice_procedures": "noreceipt",
            "color_page_count_plural_message": "You are about to print {number} color pages.",
            "color_page_count_singular_message": "You are about to print 1 color page.",
            "dialog_title": "Would you like to print?",
            "exceed_total_page_count_message": "This print job exceeds the amount of pages left in the session. Print job cancelled.",
            "failed_page_count_accounting_message": "Cancelling job since page accounting is enabled.",
            "failed_page_count_message": "Unable to determine number of pages.",
            "free_page_count_plural_message": "You will have {number} free pages left after this print job.",
            "free_page_count_singular_message": "You will have 1 free page left after this print job.",
            "other_dialog_title": "Userful Printing",
            "page_cost_message": "The cost is {price}.",
            "page_count_plural_message": "You are about to print {number} pages.",
            "page_count_singular_message": "You are about to print 1 page.",
            "print_receipt_checkbox_label": "Print Receipt",
            "total_page_count_plural_message": "You will only be able to print {number} pages after this print job.",
            "costPerPage": 1,
            "textEntryLabel": "Enter text",
            "printReceiptCheckboxLabel": "Print Receipt",
            "freePageCountSingularMessage": "You will have 1 free page left after this print job.",
            "maxEntryChars": 20,
            "exceedTotalPageCountMessage": "This print job exceeds the amount of pages left in the session. Print job cancelled.",
            "showDialog": true,
            "failedPageCountAccountingMessage": "Cancelling job since page accounting is enabled.",
            "colorPageCountSingularMessage": "You are about to print 1 color page.",
            "totalPageCountPluralMessage": "You will only be able to print {number} pages after this print job.",
            "failedPageCountMessage": "Unable to determine number of pages.",
            "dialogTitle": "Would you like to print?",
            "colorPageCountPluralMessage": "You are about to print {number} color pages.",
            "pageCountPluralMessage": "You are about to print {number} pages.",
            "global": true,
            "pageCountSingularMessage": "You are about to print 1 page.",
            "freePageCountPluralMessage": "You will have {number} free pages left after this print job.",
            "pageCostMessage": "The cost is {price}.",
            "printInvoiceProcedure": "noreceipt",
            "freePages": 25,
            "pageLimit": 100,
            "otherDialogTitle": "Userful Printing",
            "minEntryChars": 3,
            "autoReleaseJob": true,
            "showTextEntry": false
        },
        {
            "isGlobal": false,
            "queueName": "printer1",
            "print_dialog": false,
            "release_jobs": true,
            "show_text_entry": false,
            "showDialog": false,
            "global": false,
            "autoReleaseJob": true,
            "showTextEntry": false
        }
    ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

HTTP status code 404

Returned if {id} does not exist.

delete print profiles with specified queue name

URI Parameters

  • queuename: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

HTTP status code 200

Returned if success.

HTTP status code 400

Returned if {id} does not exist.

HTTP status code 401

Returned if the session id is invalid or session time out.

/serial/{seatID}

post

post

Send a serial command to a display defined by seatID

Send a serial command to a display defined by seatID

URI Parameters

  • seatID: required (string)

Headers

  • cookie: required (string)

    Put the session id to the cookie to prove that the caller has been authenticated.

    Example:

    JSESSIONID=12345678901234567890

Body

Media type: application/json

Example:

{	
	"serialSettings": {
			"baudRate": 9600,
			"dataBits": 8,
			"parity": "none",
			"stopBits": 1
	},
	"transmit":{
		"base64_data": "abcdefcg"		
	}
}

HTTP status code 200

Returned if success.

HTTP status code 400

Returned if command is unsuccessful.

HTTP status code 401

Returned if the session id is invalid or session time out.

/controlroom

get

get

Returns all the configured control room video wall instances. Name in this case referes to the videowall zone names that been assigned to control room sources.

get

get

Gets all of the layouts for a given videowall zone that has been assigned to a Command and Control source.

Gets all of the layouts for a given videowall zone that has been assigned to a Command and Control source.

URI Parameters

  • videowallZoneName: required (string)

HTTP status code 200

Body

Media type: application/json

Example:

{
  "layouts": [
    {
      "id": "2ED25B5C-7E45-468C-8BA8-5481605842DB",
      "name": "layout-1",
      "sources": [
        {
          "id": "208FF9C2-E112-41FA-B72D-616936A4FBC4",
          "name": "Camera1"
        },
        {
          "id": "3E5BF633-3DE0-4FEB-82A2-45CD338213E4",
          "name": "Camera2"
        }
      ]
    },
    {
      "id": "80D5AAE2-1311-454E-9FAE-736C326D7F1F",
      "name": "layout-2",
      "sources": [
        {
          "id": "208FF9C2-E112-41FA-B72D-616936A4FBC4",
          "name": "Camera3"
        },
        {
          "id": "3E5BF633-3DE0-4FEB-82A2-45CD338213E4",
          "name": "Camera4"
        }
      ]
    }
  ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

get

get

Gets all of the layouts for a given videowall zone. If put in a zone that doens't exist or a zone that isn't assigned to a command and control source, then you will get a response with id as an empty string and name set to "None"

Gets all of the layouts for a given videowall zone. If put in a zone that doens't exist or a zone that isn't assigned to a command and control source, then you will get a response with id as an empty string and name set to "None"

URI Parameters

  • videowallZoneName: required (string)

HTTP status code 200

Body

Media type: application/json

Example:

{
  "id": "80D5AAE2-1311-454E-9FAE-736C326D7F1F",
      "name": "layout-1",
      "sources": [
        {
          "id": "208FF9C2-E112-41FA-B72D-616936A4FBC4",
          "name": "Camera1"
        },
        {
          "id": "3E5BF633-3DE0-4FEB-82A2-45CD338213E4",
          "name": "Camera2"
        }
    ]
}

HTTP status code 401

Returned if the session id is invalid or session time out.

put

put

Loads a given layout as specified in the path.

Loads a given layout as specified in the path.

URI Parameters

  • videowallZoneName: required (string)
  • layoutName: required (string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "result": "success"
}

HTTP status code 401

Returned if the session id is invalid or session time out.