Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) - Manual (Page 18)

8 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
API naming conventions
2
API naming conventions
All of the APIs and enumerations follow the CamelCase naming convention. The API name is formed
by multiple words that are joined together as a single word. The APIs begin with a lowercase letter.
The first letter of subsequent words is capitalized so that each word that makes up the name can
be read easily. Two letter abbreviations are also capitalized if not the first word in the API name, for
example, addAcl.
The names of data structures begin with a capital letter, but all of the other API naming convention
rules apply, for example, RealServerMonitoringDetails and AclID.
Request and response XML
Most APIs make a query or a request and expect a response to the query. These requests and
responses have a data structure in which they are sent and received respectively. The data
structures contain the names of the data required and their respective data types.
getAll These APIs are used to obtain the configuration and statistics of more
than one object. The Brocade Virtual ADX device has a maximum
number of objects that can be returned on the buffer. The resultant
number of objects could be less then the total number of objects
available on the Brocade Virtual ADX device. To facilitate the collection
of details of all of the objects, these APIs contain "startIndex" and
"numRetrieved" inputs.
The “startIndex” is an index value with which you can retrieve the
information.
The "numRetrieved" is the number of entries that you want to retrieve.
The response is limited to the number of objects that can be retrieved. getAllIPSubnetVlans
bind These APIs are used to bind one object to another object in the
Brocade Virtual ADX device, for example, binding a real server to a
virtual server configured on the Brocade Virtual ADX platform. bindSipPolicyToFilter
unbind These APIs are similar to the bind APIs, and they are used to unbind an
object from another object on the Brocade Virtual ADX platform. unbindSipServers
TABLE 1 API operations
Basic API
operations Description Example