Overview
Error Handling

Methods

API Documentation (API Version v1)

Utilities/Info/

DESCRIPTION

This section contains some basic methods for getting the version and state of the api.

ping

URL:

https://api.stormondemand.com/v1/Utilities/Info/ping

Description:

This method can be used as a basic check to see if communication with the api is possible.

Parameters:

No Values Defined

Returns:

FieldType
pingA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

version

URL:

https://api.stormondemand.com/v1/Utilities/Info/version

Description:

Returns the version of the of the api your are using.

Parameters:

No Values Defined

Returns:

FieldType
versionA string of text, containing no newlines or other control characters.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types