The administrative API
This section outlines the structure of the eleven XML
method calls and their responses, and the exception XML that is
used to report errors. The general structure of the XML is as follows:
- The root element is always a BCGPublicAPI element
- The first child of the root in a request document is the <MethodName> element.
- The first child of the <MethodName> element is the UserInfo element. This element contains your (the user making the
request) Community Console login information. You must have permissions
that are adequate for the task being attempted.
- The second child of the <MethodName> element represents any input parameters.
- The first child of the root in a response document is the <MethodName>Response element. This element represents results of the execution
of the request API.
- The first child of the root in an exception document is a BCGPublicAPIException element.
