api

Description

Methods providing information about the API.

Namespace:

api

Method: getApiCallList

HTTP GET

Description:

Lists all available api calls grouped by namespace

Parameters:

  • string sessionKey

Returns:

  • struct method_info

    • string "name" - method name

    • string "parameters" - method parameters

    • string "exceptions" - method exceptions

    • string "return" - method return type

Method: getApiNamespaceCallList

HTTP GET

Description:

Lists all available api calls for the specified namespace

Parameters:

  • string sessionKey

  • string namespace

Returns:

  • struct method_info

    • string "name" - method name

    • string "parameters" - method parameters

    • string "exceptions" - method exceptions

    • string "return" - method return type

Method: getApiNamespaces

HTTP GET

Description:

Lists available API namespaces

Parameters:

  • string sessionKey

Returns:

  • struct namespace

    • string "namespace" - API namespace

    • string "handler" - API Handler

Method: getVersion

HTTP GET

Description:

Returns the version of the API.

Parameters:

Returns:

  • string version

Method: systemVersion

HTTP POST

Description:

Returns the server version.

Parameters:

Returns:

  • string version