Conventions

This guide uses industry standard conventions for displaying code that you are already familiar with.

However, API reference is a formal definition of the API contract between a calling application and the server. As such, the syntax definitions of request URLs should be described.

We have placed distinct sections of a request URL on separate lines for readability, like this:

http://server_name/api/xml
    ?action=custom-fields
    &filter-definition=value
    &session=BreezeSessionCookieValue

When you enter a request URL in the address bar of a browser or construct it in an application, enter it or construct it as a single line:

https://example.com/api/xml?action=custom-fields&filter-name=location

Syntax elements in blue code font represent definitions that you construct, with a hyperlink to the syntax of the definition.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/00_intr9.htm