LEC 15.5.1 REST API Reference Guide - Cisco€¦ · For more information on LEC refer to the latest...

LEC 15.5.1 REST API Reference Guide

Table of ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

URI scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Read LEC configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Search diagnostic logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

List event groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Fire soft button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Read LEC mirror enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Set LEC mirror enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Login a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Logout a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

List mirror hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Set mirror hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

List programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Renew a session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Read the schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Set the schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Read server timezone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Search transaction logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Read transaction log details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

List virtual channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

JaretDateFormatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

MirrorHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

StartTimeTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

JaretDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

VirtualChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

DiagnosticLogRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

EventGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

TransactionLogDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

TransactionLogRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

EndTimeTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

LecConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

SessionRest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

DiagnosticLogFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

TransactionLogFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

ButtonTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THISMANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TOBE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIRAPPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYINGPRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOUARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of aprogram developed by the University of California, Berkeley (UCB) as part ofUCB’s public domain version of the UNIX operating system. All rights reserved.Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILESAND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALLFAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALLWARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION,THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, ORTRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT,SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OFTHE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITSSUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this documentare not intended to be actual addresses and phone numbers. Any examples,command display output, network topology diagrams, and other figuresincluded in the document are shown for illustrative purposes only. Any use ofactual IP addresses or phone numbers in illustrative content is unintentionaland coincidental.

All printed copies and duplicate soft copies are considered un-Controlled copiesand the original on-line version should be referred to for latest version.

1

Cisco has more than 200 offices worldwide. Addresses, phone numbers, and faxnumbers are listed on the Cisco website at www.cisco.com/go/offices.

Cisco and the Cisco logo are trademarks or registered trademarks of Ciscoand/or its affiliates in the U.S. and other countries. To view a list of Ciscotrademarks, go to this URL: www.cisco.com/go/trademarks. Third-partytrademarks mentioned are the property of their respective owners. The use ofthe word partner does not imply a partnership relationship between Cisco andany other company. (1110R)

© 2018 Cisco Systems, Inc. All rights reserved.

OverviewLEC REST API provides capability of integration with third party management systems in order toconfigure LEC programs and trigger soft buttons.

REST interaction should start with login request Login a user. Token is returned as apart of loginresponse. Any further REST api request should contain a token in the request URI as specified inAPI examples.

For more information on LEC refer to the latest PNC 15.5.1 User Guide. LEC is described in aseparate section inside PNC User Guide.

Version informationVersion: LEC 15.5.1

URI schemeHost: localhost BasePath: /lec

Tags• lec-rest-controller: Lec Rest Controller

Paths

Read LEC configuration

GET /rest/config

2

http://www.cisco.com/go/offices

http://www.cisco.com/go/trademarks

https://www.cisco.com/c/en/us/support/video/powervu-network-centre-management/products-user-guide-list.html

Description

Read LEC configuration

Parameters

Type Name Description Required Schema Default

QueryParameter

token token true string

Responses

HTTP Code Description Schema

200 OK LecConfiguration

500 Internal Server Error No Content

Consumes

• application/json

Produces

• /

Tags

• lec-rest-controller

Example CURL request

$ curl 'https://pnchost/lec/rest/config?token=MSMxMjqa5a%2BJpvqZ6w%3D%3D' -i

Example HTTP request

GET /lec/rest/config?token=MSMxMjqa5a%2BJpvqZ6w%3D%3D HTTP/1.1Host: pnchost

Example HTTP response

3

HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8Content-Length: 166

{ "displayString" : "LecConfiguration", "hostname" : "lec", "customerCode" : 202, "lecId" : 0, "gdsPid" : 94, "bandwidth" : 50000, "debugMode" : false}

Search diagnostic logs

POST /rest/diaglog/search

Description

Search diagnostic logs

Parameters


BodyParameter filter filter true DiagnosticLogFilter

QueryParameter


Responses


200 OK DiagnosticLogRecord array


Consumes


Produces

• /

4

Tags



$ curl 'https://pnchost/lec/rest/diaglog/search' -i -X POST -H 'Content-Type:application/json' -d '{ "id" : -1, "idRelation" : null, "severities" : [ ], "dateFrom" : null, "dateUntil" : null, "summary" : "", "description" : "", "sortColumn" : "DiagnosticLog.severity", "sortAsc" : false, "maxRowCount" : 30000}'


POST /lec/rest/diaglog/search HTTP/1.1Content-Type: application/jsonHost: pnchostContent-Length: 232

{ "id" : -1, "idRelation" : null, "severities" : [ ], "dateFrom" : null, "dateUntil" : null, "summary" : "", "description" : "", "sortColumn" : "DiagnosticLog.severity", "sortAsc" : false, "maxRowCount" : 30000}



[ {

5

"id" : 3, "date" : 1530226134000, "description" : "Warning 3 description", "displayString" : "Warning 3 synopsis", "severity" : "WARNING", "summary" : "Warning 3 synopsis"}, { "id" : 17, "date" : 1547680059521, "description" : "LEC - <10.11.12.60, 94> [c?,s?] - Connection timed out:/10.11.12.60:8022. Check if the ip is reachable. Will try to reconnect after 2000million seconds. Retrycount: 1.", "displayString" : "dcm connection", "severity" : "WARNING", "summary" : "dcm connection"}, { "id" : 76, "date" : 1547680065608, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 39, "date" : 1547680064095, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 2, "date" : 1530226133000, "description" : "Info 2 description", "displayString" : "Info 2 synopsis", "severity" : "INFO", "summary" : "Info 2 synopsis"}, { "id" : 7, "date" : 1547680051335, "description" : "Starting Notification Processor", "displayString" : "NotificationProcessor", "severity" : "INFO", "summary" : "NotificationProcessor"}, { "id" : 8, "date" : 1547680052914, "description" : "Starting LEC Scheduler", "displayString" : "Scheduler", "severity" : "INFO", "summary" : "Scheduler"}, {

6

"id" : 9, "date" : 1547680053440, "description" : "Init connection(s) to 1 dcm(s): 10.11.12.60,", "displayString" : "DcmCommService", "severity" : "INFO", "summary" : "DcmCommService"}, { "id" : 10, "date" : 1547680053502, "description" : "Load programs", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 11, "date" : 1547680053515, "description" : "The operation finished successfully: Loaded End event to Program id1(Top Gear) time 2019-01-16 19:06:30.428", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 12, "date" : 1547680053523, "description" : "The operation finished successfully: Loaded End event to Program id2(Olympics live) time 2019-01-16 20:22:30.432", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 13, "date" : 1547680053547, "description" : "The operation finished successfully: Loaded End event to Program id3(NBA) time 2019-01-16 22:52:30.433", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 14, "date" : 1547680053571, "description" : "The operation finished successfully: Loaded Start event to Programid 4(Football - Slavia vs. Sparta) time 2019-01-16 20:42:30.434", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 15, "date" : 1547680053597, "description" : "The operation finished successfully: Loaded Start event to Programid 5(NHL - Rangers vs. Bulls) time 2019-01-16 18:22:30.435", "displayString" : "ScheduleProcessor",

7

"severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 16, "date" : 1547680053614, "description" : "The operation finished successfully: Loaded finished: ScheduledEvents -- 5 added, 1 skipped; Button Events -- 3 added, 0 skipped.", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 41, "date" : 1547680064197, "description" : "Fire soft button:B1", "displayString" : "fireSoftButton", "severity" : "INFO", "summary" : "fireSoftButton"}, { "id" : 73, "date" : 1547680065485, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 44, "date" : 1547680064353, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 47, "date" : 1547680064590, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 52, "date" : 1547680064877, "description" : "Load programs", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 53, "date" : 1547680064882, "description" : "The operation finished successfully: Loaded End event to Program id7(Top Gear) time 2019-01-16 19:06:30.428", "displayString" : "ScheduleProcessor",

8

"severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 54, "date" : 1547680064887, "description" : "The operation finished successfully: Loaded End event to Program id8(Olympics live) time 2019-01-16 20:22:30.432", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 55, "date" : 1547680064892, "description" : "The operation finished successfully: Loaded End event to Program id9(NBA) time 2019-01-16 22:52:30.433", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 56, "date" : 1547680064897, "description" : "The operation finished successfully: Loaded Start event to Programid 10(Football - Slavia vs. Sparta) time 2019-01-16 20:42:30.434", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 57, "date" : 1547680064904, "description" : "The operation finished successfully: Loaded Start event to Programid 11(NHL - Rangers vs. Bulls) time 2019-01-16 18:22:30.435", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 58, "date" : 1547680064909, "description" : "The operation finished successfully: Loaded finished: ScheduledEvents -- 5 added, 1 skipped; Button Events -- 3 added, 0 skipped.", "displayString" : "ScheduleProcessor", "severity" : "INFO", "summary" : "ScheduleProcessor"}, { "id" : 60, "date" : 1547680065071, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 63,

9

"date" : 1547680065172, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 65, "date" : 1547680065199, "description" : "", "displayString" : "getLecConfiguration", "severity" : "INFO", "summary" : "getLecConfiguration"}, { "id" : 67, "date" : 1547680065271, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 70, "date" : 1547680065380, "description" : "login: user:lecadmin", "displayString" : "LoginService", "severity" : "INFO", "summary" : "LoginService"}, { "id" : 1, "date" : 1530226132000, "description" : "Error 1 description", "displayString" : "Error 1 synopsis", "severity" : "ERROR", "summary" : "Error 1 synopsis"} ]

List event groups

GET /rest/evtgrp/list

Description

Read event groups

Parameters

10


QueryParameter


Responses


200 OK EventGroup array


Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/evtgrp/list?token=MSMxMTo6oatfmKIg4A%3D%3D' -i


GET /lec/rest/evtgrp/list?token=MSMxMTo6oatfmKIg4A%3D%3D HTTP/1.1Host: pnchost


11


[ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : ""}, { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : ""}, { "displayString" : "Europe", "id" : 3, "name" : "Europe", "notes" : ""}, { "displayString" : "Africa", "id" : 4, "name" : "Africa", "notes" : ""}, { "displayString" : "Asia", "id" : 5, "name" : "Asia", "notes" : ""}, { "displayString" : "Australia", "id" : 6, "name" : "Australia", "notes" : ""}, { "displayString" : "Antartica", "id" : 7, "name" : "Antartica", "notes" : ""}, { "displayString" : "No man\"s land", "id" : 8, "name" : "No man\"s land", "notes" : ""} ]

Fire soft button

12

POST /rest/firebutton/{button}

Description

Fire soft button

Parameters


QueryParameter


PathParameter button button true string

Responses


200 OK string


Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/firebutton/B1' -i -X POST -d 'token=MSM4OnqQAYqbsFli'


POST /lec/rest/firebutton/B1 HTTP/1.1Host: pnchostContent-Type: application/x-www-form-urlencoded

token=MSM4OnqQAYqbsFli

13


HTTP/1.1 200 OK

Read LEC mirror enable

GET /rest/lec_mirror/enable

Description

Read LEC mirror enable

Parameters


QueryParameter


Responses


200 OK boolean


Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/lec_mirror/enable?token=MSM0OhB8K3ckzAM8' -i

14


GET /lec/rest/lec_mirror/enable?token=MSM0OhB8K3ckzAM8 HTTP/1.1Host: pnchost



true

Set LEC mirror enable

PUT /rest/lec_mirror/enable

Description

Set LEC mirror enable

Parameters


QueryParameter


BodyParameter enable enable true boolean

Responses


200 OK boolean


Consumes


Produces

• /

15

Tags



$ curl 'https://pnchost/lec/rest/lec_mirror/enable' -i -X PUT -H 'Content-Type:application/json' -d 'false'


PUT /lec/rest/lec_mirror/enable HTTP/1.1Content-Type: application/jsonHost: pnchostContent-Length: 5

false



false

Login a user

POST /rest/login

Description

Login a user

Parameters


QueryParameter

username username true string

QueryParameter

password password true string

16


QueryParameter

permission permission true boolean

QueryParameter

version version true boolean

Responses


200 OK SessionRest


Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/login' -i -X POST -H 'Accept: application/json' -d'username=lecadmin&password=0398a2cbcebe784d10360562c28a4b07&permission=true&version=1'


POST /lec/rest/login HTTP/1.1Accept: application/jsonHost: pnchostContent-Type: application/x-www-form-urlencoded

username=lecadmin&password=0398a2cbcebe784d10360562c28a4b07&permission=true&version=1


17


{ "session" : { "id" : 1, "user" : { "id" : 1, "username" : "lecadmin", "password" : "0398a2cbcebe784d10360562c28a4b07", "firstName" : null, "lastName" : null, "email" : null, "lastLogin" : 1547680062702, "ipAddress" : null }, "writePermitted" : true, "validUntil" : 1547680182702 }, "token" : "MSMxOiQ7S+QaI96/", "computerDescription" : null}

Logout a user

POST /rest/logout

Description

Logout a user

Parameters


QueryParameter


Responses


200 OK SessionRest


18

Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/logout' -i -X POST -H 'Accept: application/json' -d'token=MSMyOtA0kqQHQYHB'


POST /lec/rest/logout HTTP/1.1Accept: application/jsonHost: pnchostContent-Type: application/x-www-form-urlencoded

token=MSMyOtA0kqQHQYHB



{ "session" : null, "token" : "logout succeeded", "computerDescription" : null}

List mirror hosts

GET /rest/mirror_host/list

19

Description

List mirror hosts

Parameters


QueryParameter


Responses


200 OK MirrorHost array


Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/mirror_host/list?token=MSM1Ooj5uJGEkzaP' -i


GET /lec/rest/mirror_host/list?token=MSM1Ooj5uJGEkzaP HTTP/1.1Host: pnchost


20


[ { "enabled" : true, "ipAddress" : "128.2.2.3"}, { "enabled" : false, "ipAddress" : "128.4.5.6"}, { "enabled" : true, "ipAddress" : "128.9.3.3"} ]

Set mirror hosts

PUT /rest/mirror_host/list

Description

Set mirror hosts

Parameters


QueryParameter


BodyParameter hostList hostList true MirrorHostarray

Responses


200 OK MirrorHost array


Consumes


21

Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/mirror_host/list' -i -X PUT -H 'Content-Type:application/json' -d '[ { "enabled" : true, "ipAddress" : "128.2.2.3"}, { "enabled" : true, "ipAddress" : "128.4.5.6"}, { "enabled" : false, "ipAddress" : "128.9.3.3"}, { "enabled" : true, "ipAddress" : "10.85.160.12"} ]'


PUT /lec/rest/mirror_host/list HTTP/1.1Content-Type: application/jsonHost: pnchostContent-Length: 218

[ { "enabled" : true, "ipAddress" : "128.2.2.3"}, { "enabled" : true, "ipAddress" : "128.4.5.6"}, { "enabled" : false, "ipAddress" : "128.9.3.3"}, { "enabled" : true, "ipAddress" : "10.85.160.12"} ]

22



[ { "enabled" : true, "ipAddress" : "128.2.2.3"}, { "enabled" : true, "ipAddress" : "128.4.5.6"}, { "enabled" : false, "ipAddress" : "128.9.3.3"}, { "enabled" : true, "ipAddress" : "10.85.160.12"} ]

List programs

GET /rest/program/list

Description

List programs

Parameters


QueryParameter


Responses


200 OK Program array


Consumes


23

Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/program/list?token=MSMxMzqd0bwGULyGgw%3D%3D' -i


GET /lec/rest/program/list?token=MSMxMzqd0bwGULyGgw%3D%3D HTTP/1.1Host: pnchost



[ { "id" : 7, "name" : "Top Gear", "notes" : "Everything is rubbish according to Jeremy Clarkson", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "HBO", "id" : 2, "name" : "HBO", "originalNetworkId" : 1, "transportStreamId" : 101,

24

"notes" : "" }, "enabled" : true }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "BBC", "id" : 4, "name" : "BBC", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547682750428 }, "disarmTime" : { "value" : 1547684550428 } } ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" }, { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "Europe", "id" : 3, "name" : "Europe", "notes" : "" } ], "startTime" : { "value" : 1547680050428 }, "endTime" : { "value" : 1547683590428 }}, { "id" : 8,

25

"name" : "Olympics live", "notes" : "Example note for the Olympics program!", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Olympics live", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Olympics live", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547683350432 }, "endTime" : { "value" : 1547688150432 }}, { "id" : 9, "name" : "NBA", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NBA", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NBA", "virtualChannel" : { "displayString" : "Cartoon Network", "id" : 3, "name" : "Cartoon Network", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" },

26

"enabled" : true }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547688150433 }, "endTime" : { "value" : 1547697150433 }}, { "id" : 10, "name" : "Football - Slavia vs. Sparta", "notes" : "A VERY important football match", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "Antartica", "id" : 7, "name" : "Antartica", "notes" : "" } ], "startTime" : { "value" : 1547689350434 },

27

"endTime" : { "value" : 1547693550434 }}, { "id" : 11, "name" : "NHL - Rangers vs. Bulls", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547681850435 }, "disarmTime" : { "value" : 1547683350435 } } ], "targetGroups" : [ { "displayString" : "Africa", "id" : 4, "name" : "Africa",

28

"notes" : "" } ], "startTime" : { "value" : 1547680950435 }, "endTime" : { "value" : 1547683050435 }}, { "id" : 12, "name" : "Cooking", "notes" : "Drooling program", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547689950437 }, "disarmTime" : { "value" : 1547693550437 } } ], "targetGroups" : [ { "displayString" : "Australia", "id" : 6, "name" : "Australia", "notes" : "" } ],

29

"startTime" : { "value" : 1547685150437 }, "endTime" : { "value" : 1547691750437 }} ]

Renew a session

POST /rest/renewsession

Description

Renew a session

Parameters


QueryParameter


Responses


200 OK SessionRest


Consumes


Produces

• /

Tags



30

$ curl 'https://pnchost/lec/rest/renewsession' -i -X POST -H 'Accept:application/json' -d 'token=MSMzOi1O%2BLsUNTQx'


POST /lec/rest/renewsession HTTP/1.1Accept: application/jsonHost: pnchostContent-Type: application/x-www-form-urlencoded

token=MSMzOi1O%2BLsUNTQx



{ "session" : null, "token" : "renew succeeded", "computerDescription" : null}

Read the schedule

GET /rest/schedule

Description

Read the schedule

Parameters


QueryParameter


Responses


200 OK Schedule

31



Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/schedule?token=MSM5OgvII62qe9fc' -i


GET /lec/rest/schedule?token=MSM5OgvII62qe9fc HTTP/1.1Host: pnchost



{ "programs" : [ { "id" : 1, "name" : "Top Gear", "notes" : "Everything is rubbish according to Jeremy Clarkson", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" },

32

"enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "HBO", "id" : 2, "name" : "HBO", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "BBC", "id" : 4, "name" : "BBC", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547682750428 }, "disarmTime" : { "value" : 1547684550428 } } ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" }, { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "Europe", "id" : 3, "name" : "Europe",

33

"notes" : "" } ], "startTime" : { "value" : 1547680050428 }, "endTime" : { "value" : 1547683590428 } }, { "id" : 2, "name" : "Olympics live", "notes" : "Example note for the Olympics program!", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Olympics live", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Olympics live", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547683350432 }, "endTime" : { "value" : 1547688150432 } }, { "id" : 3, "name" : "NBA", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NBA", "virtualChannel" : null, "enabled" : false },

34

"endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NBA", "virtualChannel" : { "displayString" : "Cartoon Network", "id" : 3, "name" : "Cartoon Network", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547688150433 }, "endTime" : { "value" : 1547697150433 } }, { "id" : 4, "name" : "Football - Slavia vs. Sparta", "notes" : "A VERY important football match", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : null, "enabled" : false },

35

"buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "Antartica", "id" : 7, "name" : "Antartica", "notes" : "" } ], "startTime" : { "value" : 1547689350434 }, "endTime" : { "value" : 1547693550434 } }, { "id" : 5, "name" : "NHL - Rangers vs. Bulls", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : {

36

"value" : 1547681850435 }, "disarmTime" : { "value" : 1547683350435 } } ], "targetGroups" : [ { "displayString" : "Africa", "id" : 4, "name" : "Africa", "notes" : "" } ], "startTime" : { "value" : 1547680950435 }, "endTime" : { "value" : 1547683050435 } }, { "id" : 6, "name" : "Cooking", "notes" : "Drooling program", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547689950437 },

37

"disarmTime" : { "value" : 1547693550437 } } ], "targetGroups" : [ { "displayString" : "Australia", "id" : 6, "name" : "Australia", "notes" : "" } ], "startTime" : { "value" : 1547685150437 }, "endTime" : { "value" : 1547691750437 } } ], "buttons" : [ { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, { "displayString" : "B2", "id" : 2, "name" : "B2", "enabled" : true, "notes" : "Button 2" }, { "displayString" : "B3", "id" : 3, "name" : "B3", "enabled" : true, "notes" : "Button 3" }, { "displayString" : "B4", "id" : 4, "name" : "B4", "enabled" : true, "notes" : "Button 4" }, { "displayString" : "B5", "id" : 5, "name" : "B5", "enabled" : true, "notes" : "Button 5" }, { "displayString" : "B6", "id" : 6, "name" : "B6",

38

"enabled" : true, "notes" : "Button 6" }, { "displayString" : "B7", "id" : 7, "name" : "B7", "enabled" : true, "notes" : "Button 7" }, { "displayString" : "B8", "id" : 8, "name" : "B8", "enabled" : true, "notes" : "Button 8" } ], "eventGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" }, { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "Europe", "id" : 3, "name" : "Europe", "notes" : "" }, { "displayString" : "Africa", "id" : 4, "name" : "Africa", "notes" : "" }, { "displayString" : "Asia", "id" : 5, "name" : "Asia", "notes" : "" }, { "displayString" : "Australia", "id" : 6, "name" : "Australia", "notes" : "" }, { "displayString" : "Antartica", "id" : 7, "name" : "Antartica", "notes" : "" }, {

39

"displayString" : "No man\"s land", "id" : 8, "name" : "No man\"s land", "notes" : "" } ], "virtualChannels" : [ { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "HBO", "id" : 2, "name" : "HBO", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "Cartoon Network", "id" : 3, "name" : "Cartoon Network", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "BBC", "id" : 4, "name" : "BBC", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "Animax", "id" : 5, "name" : "Animax", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "MTV", "id" : 6, "name" : "MTV", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "CBS", "id" : 7, "name" : "CBS",

40

"originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, { "displayString" : "Discovery Channel", "id" : 8, "name" : "Discovery Channel", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" } ]}

Set the schedule

PUT /rest/schedule

Description

Set the schedule

Parameters


BodyParameter schedule schedule true Schedule

QueryParameter


QueryParameter

localForceSubmit

localForceSubmit

true boolean

Responses


200 OK integer (int64)


Consumes


Produces

• /

41

Tags



$ curl 'https://pnchost/lec/rest/schedule' -i -X PUT -H 'Content-Type:application/json' -d '{ "programs" : [ { "id" : 1, "name" : "Top Gear", "notes" : "Everything is rubbish according to Jeremy Clarkson", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "HBO", "id" : 2, "name" : "HBO", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "BBC", "id" : 4, "name" : "BBC", "originalNetworkId" : 1, "transportStreamId" : 101,

42

"notes" : "" }, "armTime" : { "value" : 1547682750428 }, "disarmTime" : { "value" : 1547684550428 } } ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" }, { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "Europe", "id" : 3, "name" : "Europe", "notes" : "" } ], "startTime" : { "value" : 1547680050428 }, "endTime" : { "value" : 1547683590428 } }, { "id" : 2, "name" : "Olympics live", "notes" : "Example note for the Olympics program!", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Olympics live", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Olympics live", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true

43

}, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547683350432 }, "endTime" : { "value" : 1547688150432 } }, { "id" : 3, "name" : "NBA", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NBA", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NBA", "virtualChannel" : { "displayString" : "Cartoon Network", "id" : 3, "name" : "Cartoon Network", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547688150433 }, "endTime" : {

44

"value" : 1547697150433 } }, { "id" : 4, "name" : "Football - Slavia vs. Sparta", "notes" : "A VERY important football match", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "Antartica", "id" : 7, "name" : "Antartica", "notes" : "" } ], "startTime" : { "value" : 1547689350434 }, "endTime" : { "value" : 1547693550434 } }, { "id" : 5, "name" : "NHL - Rangers vs. Bulls", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true

45

}, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547681850435 }, "disarmTime" : { "value" : 1547683350435 } } ], "targetGroups" : [ { "displayString" : "Africa", "id" : 4, "name" : "Africa", "notes" : "" } ], "startTime" : { "value" : 1547680950435 }, "endTime" : { "value" : 1547683050435 } }, { "id" : 6, "name" : "Cooking", "notes" : "Drooling program", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : {

46

"displayString" : "End Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547689950437 }, "disarmTime" : { "value" : 1547693550437 } } ], "targetGroups" : [ { "displayString" : "Australia", "id" : 6, "name" : "Australia", "notes" : "" } ], "startTime" : { "value" : 1547685150437 }, "endTime" : { "value" : 1547691750437 } } ], "buttons" : [ { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, { "displayString" : "B2", "id" : 2, "name" : "B2", "enabled" : true,

47

"notes" : "Button 2" }, { "displayString" : "B3", "id" : 3, "name" : "B3", "enabled" : true, "notes" : "Button 3" }, { "displayString" : "B4", "id" : 4, "name" : "B4", "enabled" : true, "notes" : "Button 4" }, { "displayString" : "B5", "id" : 5, "name" : "B5", "enabled" : true, "notes" : "Button 5" }, { "displayString" : "B6", "id" : 6, "name" : "B6", "enabled" : true, "notes" : "Button 6" }, { "displayString" : "B7", "id" : 7, "name" : "B7", "enabled" : true, "notes" : "Button 7" }, { "displayString" : "B8", "id" : 8, "name" : "B8", "enabled" : true, "notes" : "Button 8" }, { "displayString" : "B9", "id" : -1, "name" : "B9", "enabled" : true, "notes" : "Button B9" } ], "eventGroups" : [ ], "virtualChannels" : [ ]}'

48


PUT /lec/rest/schedule HTTP/1.1Content-Type: application/jsonHost: pnchostContent-Length: 8156

{ "programs" : [ { "id" : 1, "name" : "Top Gear", "notes" : "Everything is rubbish according to Jeremy Clarkson", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Top Gear", "virtualChannel" : { "displayString" : "HBO", "id" : 2, "name" : "HBO", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "BBC", "id" : 4, "name" : "BBC", "originalNetworkId" : 1, "transportStreamId" : 101,

49

"notes" : "" }, "armTime" : { "value" : 1547682750428 }, "disarmTime" : { "value" : 1547684550428 } } ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" }, { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "Europe", "id" : 3, "name" : "Europe", "notes" : "" } ], "startTime" : { "value" : 1547680050428 }, "endTime" : { "value" : 1547683590428 } }, { "id" : 2, "name" : "Olympics live", "notes" : "Example note for the Olympics program!", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Olympics live", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Olympics live", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true

50

}, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547683350432 }, "endTime" : { "value" : 1547688150432 } }, { "id" : 3, "name" : "NBA", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NBA", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NBA", "virtualChannel" : { "displayString" : "Cartoon Network", "id" : 3, "name" : "Cartoon Network", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "South America", "id" : 2, "name" : "South America", "notes" : "" }, { "displayString" : "North America", "id" : 1, "name" : "North America", "notes" : "" } ], "startTime" : { "value" : 1547688150433 }, "endTime" : {

51

"value" : 1547697150433 } }, { "id" : 4, "name" : "Football - Slavia vs. Sparta", "notes" : "A VERY important football match", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true }, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: Football - Slavia vs. Sparta", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ ], "targetGroups" : [ { "displayString" : "Antartica", "id" : 7, "name" : "Antartica", "notes" : "" } ], "startTime" : { "value" : 1547689350434 }, "endTime" : { "value" : 1547693550434 } }, { "id" : 5, "name" : "NHL - Rangers vs. Bulls", "notes" : "", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "enabled" : true

52

}, "endTimeTrigger" : { "displayString" : "End Time Trigger of Program: NHL - Rangers vs. Bulls", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547681850435 }, "disarmTime" : { "value" : 1547683350435 } } ], "targetGroups" : [ { "displayString" : "Africa", "id" : 4, "name" : "Africa", "notes" : "" } ], "startTime" : { "value" : 1547680950435 }, "endTime" : { "value" : 1547683050435 } }, { "id" : 6, "name" : "Cooking", "notes" : "Drooling program", "startTimeTrigger" : { "displayString" : "Start Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "endTimeTrigger" : {

53

"displayString" : "End Time Trigger of Program: Cooking", "virtualChannel" : null, "enabled" : false }, "buttonTriggers" : [ { "button" : { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, "virtualChannel" : { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : "" }, "armTime" : { "value" : 1547689950437 }, "disarmTime" : { "value" : 1547693550437 } } ], "targetGroups" : [ { "displayString" : "Australia", "id" : 6, "name" : "Australia", "notes" : "" } ], "startTime" : { "value" : 1547685150437 }, "endTime" : { "value" : 1547691750437 } } ], "buttons" : [ { "displayString" : "B1", "id" : 1, "name" : "B1", "enabled" : true, "notes" : "Button 1" }, { "displayString" : "B2", "id" : 2, "name" : "B2", "enabled" : true,

54

"notes" : "Button 2" }, { "displayString" : "B3", "id" : 3, "name" : "B3", "enabled" : true, "notes" : "Button 3" }, { "displayString" : "B4", "id" : 4, "name" : "B4", "enabled" : true, "notes" : "Button 4" }, { "displayString" : "B5", "id" : 5, "name" : "B5", "enabled" : true, "notes" : "Button 5" }, { "displayString" : "B6", "id" : 6, "name" : "B6", "enabled" : true, "notes" : "Button 6" }, { "displayString" : "B7", "id" : 7, "name" : "B7", "enabled" : true, "notes" : "Button 7" }, { "displayString" : "B8", "id" : 8, "name" : "B8", "enabled" : true, "notes" : "Button 8" }, { "displayString" : "B9", "id" : -1, "name" : "B9", "enabled" : true, "notes" : "Button B9" } ], "eventGroups" : [ ], "virtualChannels" : [ ]}

55



1

Read server timezone

GET /rest/timezone

Description

Read server timezone

Parameters


QueryParameter


Responses


200 OK string


Consumes


Produces

• /

Tags



56

$ curl 'https://pnchost/lec/rest/timezone?token=MSMxNDqedJF4Xx6NwQ%3D%3D' -i


GET /lec/rest/timezone?token=MSMxNDqedJF4Xx6NwQ%3D%3D HTTP/1.1Host: pnchost



"America/Toronto"

Search transaction logs

POST /rest/translog/search

Description

Search transaction logs

Parameters


BodyParameter filter filter true TransactionLogFilter

QueryParameter


Responses


200 OK TransactionLogRecord array


Consumes


57

Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/translog/search' -i -X POST -H 'Content-Type:application/json' -d '{ "id" : -1, "idRelation" : null, "dateFrom" : null, "dateUntil" : null, "ipAddress" : "", "description" : "", "sortColumn" : "DiagnosticLog.date", "sortAsc" : true, "maxRowCount" : 30000}'


POST /lec/rest/translog/search HTTP/1.1Content-Type: application/jsonHost: pnchostContent-Length: 207

{ "id" : -1, "idRelation" : null, "dateFrom" : null, "dateUntil" : null, "ipAddress" : "", "description" : "", "sortColumn" : "DiagnosticLog.date", "sortAsc" : true, "maxRowCount" : 30000}



58

[ { "id" : 4, "date" : 1530226135000, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 5, "date" : 1530226136000, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 6, "date" : 1530226137000, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 40, "date" : 1547680064117, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 42, "date" : 1547680064231, "description" : "fireSoftButton", "displayString" : "[email protected], R/W: fireSoftButton", "ipAddress" : "[email protected], R/W"}, { "id" : 43, "date" : 1547680064295, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 45, "date" : 1547680064375, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 46, "date" : 1547680064533, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 48,

59

"date" : 1547680064610, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 49, "date" : 1547680064764, "description" : "setSchedule", "displayString" : "[email protected], R/W: setSchedule", "ipAddress" : "[email protected], R/W"}, { "id" : 50, "date" : 1547680064787, "description" : "Added 1 buttons.", "displayString" : "[email protected], R/W: Added 1 buttons.", "ipAddress" : "[email protected], R/W"}, { "id" : 51, "date" : 1547680064859, "description" : "Programs count:6", "displayString" : ": Programs count:6", "ipAddress" : ""}, { "id" : 59, "date" : 1547680064966, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 61, "date" : 1547680065087, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 62, "date" : 1547680065140, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 64, "date" : 1547680065187, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 66, "date" : 1547680065241, "description" : "Logout", "displayString" : "[email protected], R/W: Logout",

60

"ipAddress" : "[email protected], R/W"}, { "id" : 68, "date" : 1547680065286, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 69, "date" : 1547680065345, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 71, "date" : 1547680065396, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 72, "date" : 1547680065450, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 74, "date" : 1547680065502, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 75, "date" : 1547680065545, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 77, "date" : 1547680065622, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 78, "date" : 1547680065688, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 80,

61

"date" : 1547680065727, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"}, { "id" : 81, "date" : 1547680065781, "description" : "Logout", "displayString" : "[email protected], R/W: Logout", "ipAddress" : "[email protected], R/W"}, { "id" : 83, "date" : 1547680065829, "description" : "Login", "displayString" : "[email protected], R/W: Login", "ipAddress" : "[email protected], R/W"} ]

Read transaction log details

GET /rest/translogdetails/{id}

Description

Read transaction log details

Parameters


PathParameter id id true integer (int32)

QueryParameter


Responses


200 OK TransactionLogDetail array


Consumes


62

Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/translogdetails/1?token=MSMxNzqYEtRoSjW0qg%3D%3D' -i


GET /lec/rest/translogdetails/1?token=MSMxNzqYEtRoSjW0qg%3D%3D HTTP/1.1Host: pnchost


63


[ { "displayString" : "1 : Modified Button B9", "id" : 1, "date" : 1547680065753, "operation" : "Modified", "entityType" : "Button", "entityId" : "B9", "attribute" : "Name", "attributeOp" : "Added", "oldValue" : "-", "newValue" : "B9"}, { "displayString" : "1 : Modified Button B9", "id" : 1, "date" : 1547680065753, "operation" : "Modified", "entityType" : "Button", "entityId" : "B9", "attribute" : "Enabled", "attributeOp" : "Added", "oldValue" : "-", "newValue" : "true"}, { "displayString" : "1 : Modified Button B9", "id" : 1, "date" : 1547680065753, "operation" : "Modified", "entityType" : "Button", "entityId" : "B9", "attribute" : "Notes", "attributeOp" : "Added", "oldValue" : "-", "newValue" : "Button B9"} ]

List virtual channels

GET /rest/vc/list

Description

List virtual channels

64

Parameters


QueryParameter


Responses


200 OK VirtualChannel array


Consumes


Produces

• /

Tags



$ curl 'https://pnchost/lec/rest/vc/list?token=MSMxNTp%2FV7moE4S%2Blw%3D%3D' -i


GET /lec/rest/vc/list?token=MSMxNTp%2FV7moE4S%2Blw%3D%3D HTTP/1.1Host: pnchost



[ { "displayString" : "FOX Sport", "id" : 1, "name" : "FOX Sport", "originalNetworkId" : 1,

65

"transportStreamId" : 101, "notes" : ""}, { "displayString" : "HBO", "id" : 2, "name" : "HBO", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""}, { "displayString" : "Cartoon Network", "id" : 3, "name" : "Cartoon Network", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""}, { "displayString" : "BBC", "id" : 4, "name" : "BBC", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""}, { "displayString" : "Animax", "id" : 5, "name" : "Animax", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""}, { "displayString" : "MTV", "id" : 6, "name" : "MTV", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""}, { "displayString" : "CBS", "id" : 7, "name" : "CBS", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""}, { "displayString" : "Discovery Channel", "id" : 8, "name" : "Discovery Channel", "originalNetworkId" : 1, "transportStreamId" : 101, "notes" : ""

66

} ]

Definitions

JaretDateFormatter

Name Description Required Schema Default

locale false Locale

Locale


country false string

displayCountry false string

displayLanguage false string

displayName false string

displayScript false string

displayVariant false string

extensionKeys false Character array

iso3Country false string

iso3Language false string

language false string

script false string

unicodeLocaleAttributes

false string array

unicodeLocaleKeys

false string array

variant false string

MirrorHost


enabled false boolean

ipAddress false string

67

StartTimeTrigger


displayString false string


targetGroups false EventGroup array

time false JaretDate

virtualChannel false VirtualChannel

Program


begin false JaretDate

buttonTriggers false ButtonTriggerarray


end false JaretDate

endTime false JaretDate

endTimeTrigger false EndTimeTrigger

id false integer (int32)

name false string

notes false string

seconds false integer (int32)

startTime false JaretDate

startTimeTrigger false StartTimeTrigger


User


email false string

firstName false string



68


lastLogin false integer (int64)

lastName false string

password false string

username false string

JaretDate


date false integer (int64)

dateByText false string

day false integer (int32)

dayOfWeek false integer (int32)

dayOfWeekString false string

dayOfYear false integer (int32)

hours false integer (int32)

jaretDateFormatter

false JaretDateFormatter

locale false Locale

millis false integer (int32)

millisInDay false integer (int64)

milliseconds false integer (int32)

minutes false integer (int32)

month false integer (int32)

monthString false string


shortDayOfWeekString

false string

shortMonthString false string

weekOfYear false integer (int32)

weekendDay false boolean

year false integer (int32)

69

Character

VirtualChannel




name false string

notes false string

originalNetworkId false integer (int32)

transportStreamId false integer (int32)

DiagnosticLogRecord



description false string



severity false enum (MAJOR,MINOR, EVENT,INFO, WARNING,ERROR,UNKNOWN)

summary false string

EventGroup




name false string

notes false string

parent false Schedule

programs false Program array

70

TransactionLogDetail


attribute false string

attributeOp false string



entityId false string

entityType false string


newValue false string

oldValue false string

operation false string

Button





name false string

notes false string

TransactionLogRecord







Schedule

71


buttons false Button array

defaultButton false Button


eventGroups false EventGroup array

programs false Program array

virtualChannels false VirtualChannelarray

EndTimeTrigger





time false JaretDate


LecConfiguration


bandwidth false integer (int32)

customerCode false integer (int32)

debugMode false boolean


gdsPid false integer (int32)

hostname false string

lecId false integer (int32)

SessionRest


computerDescription

false string

session false Session

72


token false string

DiagnosticLogFilter


dateFrom false integer (int64)

dateUntil false integer (int64)



idRelation false enum(LESS_THAN,EQUAL,GREATER_THAN)

maxRowCount false integer (int32)

severities false enum (MAJOR,MINOR, EVENT,INFO, WARNING,ERROR,UNKNOWN) array

sortAsc false boolean

sortColumn false string

summary false string

TransactionLogFilter


dateFrom false integer (int64)

dateUntil false integer (int64)



idRelation false enum(LESS_THAN,EQUAL,GREATER_THAN)


maxRowCount false integer (int32)

73


sortAsc false boolean

sortColumn false string

ButtonTrigger


armTime false JaretDate

armed false boolean

begin false JaretDate

button false Button

disarmTime false JaretDate


end false JaretDate




Session



user false User

validUntil false integer (int64)

writePermitted false boolean

74

LEC 15.5.1 REST API Reference Guide - Cisco€¦ · For more information on LEC refer to the latest...

Documents

Transcript of LEC 15.5.1 REST API Reference Guide - Cisco€¦ · For more information on LEC refer to the latest...