Specifications

1-18

Cisco CRS-1 Series Carrier Routing System XML API Guide

OL-4596-02

Chapter 1 Cisco CRS-1 Series XML API Overview

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. Also, 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

are 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 are 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 returns a response. The client

can then issue another request, and so on. Therefore, the XML session between a client and the Cisco

CRS-1 Series router 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, the Cisco CRS-1 Series router includes the same ClientID value in the corresponding

<Response> tag. The ClientID value is treated as opaque data and is ignored by the 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 Chapter 11,

“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 returns

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"?>

Operation-specific content goes here

</Operation>

</Request>

Sample XML Minimum Response from Cisco CRS-1 Series Router

<?xml version="1.0" encoding="UTF-8"?>

</Response>