30.07.2012 Views

Reference Guide

Reference Guide

Reference Guide

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

HTTP Response Body<br />

Web API <strong>Reference</strong> <strong>Guide</strong><br />

The Web API HTTP response body will almost always contain an XML document of the following format:<br />

<br />

<br />

<br />

angel.eyes<br />

clusterGetServerStatus<br />

<br />

<br />

[response data here...]<br />

<br />

<br />

All API responses are enclosed in tags, and contain two sections:<br />

which includes some reference information about the request; and which<br />

includes the response data.<br />

The content of the section differs depending on the specific method called. Refer to the<br />

method's specific documentation for additional information.<br />

In error responses, the section is replaced with an section. See Error<br />

Responses for additional information.<br />

Some Web API methods will not return an XML document in case of a successful operation - specifically,<br />

methods that export large amounts of binary data such as the configurationExport method. In such cases,<br />

this is specifically indicated in the method's documentation. Note that you can check the value of the<br />

Content-type response header in order to know in advance what kind of content to expect in the<br />

response.<br />

333

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!