How to Use Class Documentation

The class documentation that follows this section will contain a class overview article along with one article for each class method.

The class method articles contain the following sections:

Introduction The introduction includes an indication of what account types the API call can used with along with a description of what calling the method will do.

Try It The Try It section is only available in the web based documentation and will not be in the printed version. Click the Try It heading to expand this section. It will display a form that you can use to fill in the parameters for the class method you are viewing. Once you have filled in the parameters click the "Generate XML Request" button and a new window will open with the XML you will send to the API to make the class method call with the parameters you specified. Within the newly opened window you will be able to click the "Execute Request" button to actually execute the API call you have created and view the live response. You can also modify the XML request within this window an execute it again. This makes it very simple to see exactly how to use the API and exactly what it responds with.

Parameters On the web based documentation click the Parameters heading to view this section. This section is also available in the printed documentation. The Parameters section displays all of the parameters that can be sent in the request to this method along with a description of the parameters functionality.

Response On the web based documentation click the Response heading to view this section. This section is also available in the printed documentation. The Response section displays all of the response fields that can be returned from the call to this method and their meaning.

Introduction	The introduction includes an indication of what account types the API call can used with along with a description of what calling the method will do.
Try It	The Try It section is only available in the web based documentation and will not be in the printed version. Click the Try It heading to expand this section. It will display a form that you can use to fill in the parameters for the class method you are viewing. Once you have filled in the parameters click the "Generate XML Request" button and a new window will open with the XML you will send to the API to make the class method call with the parameters you specified. Within the newly opened window you will be able to click the "Execute Request" button to actually execute the API call you have created and view the live response. You can also modify the XML request within this window an execute it again. This makes it very simple to see exactly how to use the API and exactly what it responds with.
Parameters	On the web based documentation click the Parameters heading to view this section. This section is also available in the printed documentation. The Parameters section displays all of the parameters that can be sent in the request to this method along with a description of the parameters functionality.
Response	On the web based documentation click the Response heading to view this section. This section is also available in the printed documentation. The Response section displays all of the response fields that can be returned from the call to this method and their meaning.