Request And Response Tags; Maximum Request Size; Minimum Response Content - Cisco CRS-1 - Carrier Routing System Router Api Manual

Cisco CRS-1 Series XML API Tags
•

Request and Response Tags

Following the XML declaration tag a client application must enclose each request stream within a set of
<Request> start and </Request> end tags. Correspondingly, the Cisco CRS-1 Series system encloses
each XML response within a set of <Response> start and </Response> end tags. A major and minor
version number will be carried on the <Request> and <Response> elements to indicate the overall
Cisco CRS-1 Series XML API version in use by the client application and router respectively.
The Cisco CRS-1 Series XML API presents a synchronous interface to client applications. The <Request>
and <Response> tags can be used by the client to correlate the request and response streams. A client
application can issue a request after which the Cisco CRS-1 Series router will return a response. The
client can then issue another request, and so on. In other words, the XML session between a client and
the Cisco CRS-1 Series router will consist of a series of alternating requests and response streams.
The client application optionally includes a ClientID attribute within the <Request> tag. The value of
the ClientID attribute must be an unsigned 32-bit integer value. If the <Request> tag contains a ClientID
attribute, then the Cisco CRS-1 Series router will include the same ClientID value in the corresponding
<Response> tag. The ClientID value will be treated as opaque data and be ignored in every other way
by the Cisco CRS-1 Series router.

Maximum Request Size

The maximum size of an XML request or response is determined by the restrictions of the underlying
transports.
Note For more information on transport specific limitations of request and response sizes, see
"XML Transport and Event Notifications."

Minimum Response Content

If a <Get> request has nothing to return for a particular operation, the Cisco CRS-1 Series router will
return the original request and an appropriate empty operation type tag. The minimum response returned
by the Cisco CRS-1 Series router in the case of a single operation (for example, <Get>, <Set>, <Delete>)
with no result data is shown in the following example.
Sample XML Request from Client Application
<?xml version="1.0" encoding="UTF-8"?>
Cisco CRS-1 Series Carrier Routing System XML API Guide
1-20
Encoding—This optional attribute specifies the standardized character set to be used. Only "UTF-8"
is supported by the Cisco CRS-1 Series router at this time. The Cisco CRS-1 Series router will
include the encoding attribute in a response only if it was specified in the corresponding request.
<Request MajorVersion="1" MinorVersion="0">
<Operation>
.
.
.
Operation-specific content goes here
...
</Operation>
</Request>
Chapter 1 Cisco CRS-1 Series XML API Overview
Chapter 11,
OL-4596-01