<<

NAME

Meta - API metadata.

FORMAL SPECIFICATION

WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/Meta.wsdl

JSON: https://api.cloudmonit.pl/2.0.0/json/Meta.json

DESCRIPTION

This document is meant for usage by API client libraries.

METHODS

ErrorsList

This method returns a list of errors that can be returned by the API. This is the same list that is displayed in a human-readable form here.

Arguments

None.

Returns

An array of objects, each containg the fields:

• code (unsigned integer)

  The error code.

• description (string)

  The error description.

• name (string)

  The error name.

Authorization

This method can be called by read-only users.

Meta

Returns the JSON or WSDL specification of the Meta API module.

WARNING

This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.

Arguments

• format (string) - optional

  The specification format you want to use. If omitted, defaults to json if you call this method using JSON request ot wsdl if you call this method with SOAP.

  Allowed values are: json, wsdl.

Returns

• encoded_meta (string)

  The specification of the module.

• format (string)

  The specification format used.

  Allowed values are: json, wsdl.

Authorization

This method can be called by read-only users.

ModulesList

Using this method, the API can supply you with some metadata about itself.

Arguments

None.

Returns

List of pointers to formal metadata of each API module.

An array of objects, each containg the fields:

• doc (string)

  The module's documentation.

• json (string)

  The JSON meta-description file for the module.

• name (string)

  The name of the module.

• wsdl (string)

  The WSDL file for the module.

Authorization

This method can be called by read-only users.

<<