Black Box ACR1000A-CTL API manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Go to page of

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Black Box ACR1000A-CTL API, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Black Box ACR1000A-CTL API one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Black Box ACR1000A-CTL API. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Black Box ACR1000A-CTL API should contain:
- informations concerning technical data of Black Box ACR1000A-CTL API
- name of the manufacturer and a year of construction of the Black Box ACR1000A-CTL API item
- rules of operation, control and maintenance of the Black Box ACR1000A-CTL API item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Black Box ACR1000A-CTL API alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Black Box ACR1000A-CTL API, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Black Box service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Black Box ACR1000A-CTL API.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Black Box ACR1000A-CTL API item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    B L A C K B O X ® A p p l i c a t i o n P r o g r a m m i n g I n t e rf a c e ( AP I) M a n u a l ServSwitch ™ iP A TH Manager API ACR 100 0A- C TL A PI Ord er toll -free in th e U.S . : C all 877- 877-B BOX (ou ts ide U.S . c all 724 - 746 -550 0 ) FREE tech nical s upp or t 24 hou rs a d ay , 7 d ays a we ek : Call 724 -7 4 6 -550 0 or fa x 7[...]

  • Page 2

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 2 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on W e ‘ r e he r e t o he l p! If y ou h a v e an y q ue st i on s a bo u t y ou r ap p li ca t io n or o ur pr odu c t s, c on tact Bla ck Bo x T ech S upport at 7 2 4 -74 6 - 5 5 0 0 or go t o blackbox.c om an d cl [...]

  • Page 3

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 3 Ser v Sw itch iP A TH Manager A PI Docu mentati on API D ocu men tatio n API versio n : 2 Change log v 2 ( I P A TH v 2.3) - added get_ devi ces, g et_ channels , connec t_ channel, disconne ct _ channel . Updated version compatibi lit y inf ormation. v 1 ( IP A T H v[...]

  • Page 4

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 4 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on Examples Input : / ap i /?v= 1 &me th od= l og i n &u se rn a me=xxxxx&p as s wo rd=xxxxx Output: <api _ response > < version> 1< / version> < t i m e s t a m p > 2 0 12 - 12 -14 12[...]

  • Page 5

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 5 Ser v Sw itch iP A TH Manager A PI Docu mentati on or <api _ response > < version> 1< / version> < t i m e s t a m p > 2 0 12 - 12 -12 12 :12 :12 < / t i m e s t a m p > < s ucce s s > 0 < / s ucce s s > <errors > <er[...]

  • Page 6

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 6 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on - d_v e rs io n ( 1 = A C R 1 000 A, 2 = A C R 1 00 2A ) - d_v a ri a nt (' ' , ' b ' = A C R 1 00 2A ) - d _ ip_ address - d _configur ed ( 0 = no , 1 = yes ) - d_v a li d_f i rm w ar e (0 = n o ,[...]

  • Page 7

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 7 Ser v Sw itch iP A TH Manager A PI Docu mentati on < d _vali d _ backup _firm ware > 1< / d _valid _ ba ckup_fir mware > < d _ firmware >2.3. 16682< / d _ firmware > < d _ backup_ firmware >2.3. 16682< / d _ backup_ firmware > < [...]

  • Page 8

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 8 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on get _ channel s This method was last updated in AP I version 2 and is compatib le with AP I request s from ver sion 2 onwards. This simple function returns a list of chan nels available to the authenticated user , for[...]

  • Page 9

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 9 Ser v Sw itch iP A TH Manager A PI Docu mentati on < cou nt _ chan nels >2< / count _c hanne ls > < chann el i tem =" 1 "> <c_ id> 3< /c_i d> < c _ name > Channel 1< / c _ name > <c _ description> Description f[...]

  • Page 10

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 1 0 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on - coun t _ ac tive_cp (the number of channel-receiver pairs in this preset that are already connec ted) - connected _ rx _count (the number of receivers in this preset that are already connected ) - view_ but ton ( [...]

  • Page 11

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 1 1 Ser v Sw itch iP A TH Manager A PI Docu mentati on connec t _channel This method was last updated in AP I version 2 and is compatib le with AP I request s from ver sion 2 onwards. This simple function connec ts a receiver to a channel. Input param eters : - t o ke n[...]

  • Page 12

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 1 2 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on con nec t _ preset This method was last updated in AP I version 1 and is compatib le with AP I request s from ver sion 1 onwards. This simple function connec ts all channel-receiver pairs in a preset. Input param et[...]

  • Page 13

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 1 3 Ser v Sw itch iP A TH Manager A PI Docu mentati on disconnec t _channel This method was last updated in AP I version 2 and is compatib le with AP I request s from ver sion 2 onwards. This func tion disconnect s a receiver , a number of receivers, or all connected re[...]

  • Page 14

    72 4 - 7 46 -5 50 0 | blac kbox.c om Pa ge 1 4 72 4 - 7 46 -5 50 0 | blac kbox.c om Ser v Sw itch iP A TH Manager A PI Docu mentati on Examples Input : /api / ? v =1 & metho d = disconnec t _ preset & token = x x x x x & id =1&force =1 Output: <api _ response > < version> 1< / version> < t i m e s t a m p > 2[...]

  • Page 15

    72 4 - 7 46 -5 50 0 | blac kbox.c om 72 4 - 7 46 -5 50 0 | blac kbox.c om P age 1 5 NO TES[...]

  • Page 16

    72 4 - 7 46 -5 50 0 | blac kbox.c om About Bl ack Bo x Black Box provides an e xtensive range of networking and infrastructure product s. Y ou’l l find every thing from c abinets and racks a nd po w er an d s ur ge p ro t ect io n pr od u cts t o m ed ia c on ve rt er s a nd E t he rn et sw it ch es al l s u ppo rt ed b y f re e , l iv e 2 4/ 7 T[...]