Skip to content

Error Object

Should one of the resources be used incorrectly or if the resource didn't return any data, an HTTP Status = '400 Bad Request' will be returned along with an "error" object in the Response Body containing one of these errors. It will be returned in a data format as defined by the Output parameter.

Missing Parameters

If the resource is unhappy about not being passed the appropriate parameters, a message similar to this one will be returned, but with specific information related to the actual error:

Example

'error' => 
array (
    'title' => 'Missing Parameters',
    'detail' => 'It appears you have tried to access the resource without passing required parameters.',
    'resource_server' => 'https://rest.omegatower.ninja/toolbox/v1',
    'type' => 1,
    'source' => 'C1',
)

Invalid Parameter Value

If the resource is unhappy about one of the values you sent in a parameter, a message similar to this one will be returned, but with specific information related to the actual error:

Example

'error' => 
array (
    'title' => 'Invalid Parameter Value',
    'detail' => 'It appears that one of the parameters you entered has an invalid value: test.',
    'resource_server' => 'https://rest.omegatower.ninja/toolbox/v1',
    'type' => 2,
    'source' => 'C2',
)

No Output Generated

If the resource doesn't return any data, a message similar to this one will be returned, but with specific information related to the actual error:

Example

'error' => 
array (
    'title' => 'No Output Generated',
    'detail' => 'It appears that no output was generated using the parameters you entered.',
    'resource_server' => 'https://rest.omegatower.ninja/toolbox/v1',
    'type' => 3,
    'source' => 'C12',
)

Characters Initial Range Too Large

If for some reason the initial range of values between the 'start' and 'end' parameters for the Characters resource is greater then 256, a message similar to this one will be returned, but with specific information related to the actual error:

Example

'error' => 
array (
    'title' => 'Initial Range Too Large',
    'detail' => 'It appears that the initial range using the parameters you entered is too large. The maximum allowed is 256. Initial Range = 12700.',
    'resource_server' => 'https://rest.omegatower.ninja/toolbox/v1',
    'type' => 5,
    'source' => 'C10',
)

Quotes Separator Length Too Large

If the number of values in the separator parameter in the Quotes resource is greater then 8, a message similar to this one will be returned, but with specific information related to the actual error:

Example

'error' => 
array (
    'title' => 'Separator Length Too Large',
    'detail' => 'It appears that the separator parameter you entered contains too many values. The maximum allowed is 8. Count = 15.',
    'resource_server' => 'https://rest.omegatower.ninja/toolbox/v1',
    'type' => 6,
    'source' => 'Q7',
)
Back to top