Web Services; Web Services Interface - VBrick 9000 Getting Started Manual

Web Services

Web Services Interface

The VBrick encoder provide a standards-based SOAP architecture to programmatically
interface to the encoder. The Web Service interface allows the user application to
MIB parameters in the encoder. The methods supported by the service are listed below.
Method
getNewSessionId (device)
test (echoString)
login (sessionId, loginName,
hashedPassword)
beginEdit (sessionId, editName)
endEdit (sessionId)
endOtherEdit (sessionId)
logout (sessionId)
getParameterValue (sessionId,
parnName, parmIndex)
setParameterValue (sessionId,
parmName, parmIndex, parmValue)
setMultipleParameterValue (sessionId,
parmName, parmValue, count)
The WSDL file for the Web service methods can be obtained by calling the following URL
where
<encoder_ip_address>
resolved to an IP by the local DNS server.
http://<encoder_ip_address>/VBrickWebSrvc/VBrickWebSrvc.wsdl
All methods return
for methods that complete successfully.
Encoder Getting Started
Description
Used to get a new session id from the encoder. It allows the
Web service to maintain session with the encoder.
Used as a test Web service method to test if the interface to
the encoder is working. It returns the input string as an echo.
Used as method to allows the user to login into the box as a
particular user with appropriate privileges. Returns
successful,
ERROR
Used as a method to begin the edit session to become editor
of parameters. Returns
otherwise.
Used as a method to end the editor session. Returns
successful,
ERROR
Used as a method to forcefully end another editor session.
Returns if successful,
OK
Used to logout of a Web session. Returns
otherwise.
ERROR
Used as a parameter to get a parameter value. Returns
parameter value as a string if successful,
Used as a method to set a parameter value. Returns
successful,
ERROR
Used as a method to set multiple parameter values, where
is a string array of names,
parmName
array of values to the corresponding array of names, and
count is the number of items in the array. Returns
successful,
ERROR
is the IP address of the encoder or a host name that can be
as the response if the request cannot be fulfilled.
ERROR
GetNewSessionId
Chapter 8
otherwise.
if successful,
editName
otherwise.
otherwise.
ERROR
OK
ERROR
otherwise.
parmValue
otherwise.
returns a new SessionId if it
Get/Set
if
OK
ERROR
if
OK
if successful,
otherwise
if
OK
is a string
if
OK
is returned
OK
47