UseResponse API reference

Requests

UseResponse API requests should utilize following URL structure:
http://www.youruseresponse.com/api/format/module/method/parameter1/value1/api_key/u8dHbPsRnuivcIfuFzwvX9j9qjEFBjXh

URL structure explained:

format

Specifies response format expected.

Expected values:

Default value: json

module

Specifies module to request API method from.

Expected values:

Default value: system

method

Specifies API method to call.

Expected values: could be found on following pages of this API reference:

Default value: system

parameter/value pair

Majority of UseResponse API methods accept one or more parameters.

Expected values: parameter/value

api_key

API key is required to be appended to all requests to UseResponse API

Expected value: unique, 32 characters long alphanumeric string

Responses

Each API response contains both response code and result itself. Response code is returned as HTTP Response status code, response itself is in HTTP response body. Below are response codes explained: