Grass Valley iControl Services Gateway - Manual (Page 10)

Page 10 of 26
iControl™ API Specifications
API G ENERIC S PECIFICATIONS
An application exchan ge information with a Service Node registered within an iControl™Gateway
through XML formatted commands.
A Service Node confirms a command by replying to the issuing application the XML token <ack/>.
Some commands will not return the confirmation message <ack/>, but directly the reply message.
A Service Node rejects a syntactically incorrect command by replying to the issuing application the XML
tag <nack/>.
All XML messages sent to by iControl™Gateway or Service Node must finish with the character CR
(0x0D)
–Carriage Return.
No other character or group of characters not being part of the command syntax is allowed to be inserted
before the XML message or inside the XML message
. They will be rejected by iControl™Gateway
All XML messages returned by iContro l™Gateway or Service Node are finished with characters CR LF.
In all the following command descriptions and examples in this document, the terminating characters will
be omitted.
I
C ONTROL
™ G ATEWAY D IRECTORY S ERVICES C OMMANDS
In order for an application to obtain the list of iControl™ Service Nodes registered in an
iControl™Gateway,the application shall establish a TCP/IP-XML session with the iControl™ Gateway
Directory Services, over a TCP/IP socket on the port 10001 of the iControl™ Gateway.
The applic ation can then send any of the following XML commands to the iControl™ Gateway Directory
Services:

listNodes

getGatewayVersion

nodeCount

getNode

getNextNode
The XML command must be finished with the \r (Carriage Return) character.
The XML response returned by iControl™ Gateway Directory Services will be finished by the \r\n
characters
Example: <listNodes/>\r\n
1.1.8 C OMMAND LIST N ODE
Purpose:
Query an iControl™ Directory Services the list of Service Nodes registered to an iControl™ Gateway.
Pre-Requisites:

IP a ddress of the iControl™ Gateway host is known.