The following instructions can help you analyze an XML API schema.
If you use API RPC 184.108.40.206 or higher:
agent_input.xsdschema. It lists all supported operator elements within the packet element. For example,
On the above figure, complex data type RequestPacketType lists all operator elements supported in API RPC 220.127.116.11. These operators are: server, client, domain, etc. Each operator has a matching request data type (the type attribute). This data type describes the structure of the operator.
agent_input.xsdlists all subsequent schemas as follows:
The schema name contains the name of the operator you need and the
client_input.xsdschema (v.18.104.22.168) matching the client operator.
The client operator is described by type ServerOperatorType (highlighted). To see its structure, click the + sign to the left and expand the section.
agent_input.xsdschema) declares operations that can be applied to the relevant object.
client_input.xsdschema as follows:
All nested elements (operation parameters) are described by specific data types. You can find their definitions either in the same schema, or in the included schema:
Thus, when you analyse the schemas, the approach is as follows: start with the main schema to choose the operator and drill down to the subsequent data types that can be found in the included schemas.
If you use API RPC 22.214.171.124 or lower, find the required input schema by its name. The schema describes the structure of the XML packet within the packet element: It contains a single operator element that, in turn, contains some operation elements. Operations are structured as described above: Each operation is a complex data type that contains sequences of various parameters. Some parameters are fully defined within the operation element, others have just a complex data type specified against them. Such data types can be defined in the same schema or in some other schema included into this one with the include directive.