HTTP Status Codes - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
First publish date
2006

This table provides the HTTP status codes.

Token based authentication web services calls

Obtaining the token
Status Code Short Description Description
200 OK The request is successful. The access_token will be returned in response as { "access_token": "{Your acess token}" }.
401 Unauthorized This either means that your BasicAuth credentials are not correct or that your Spectrum OnDemand account is not configured to use token based authentication. You can reach out to Precisely Support to enable token based authentication for your account. This will be returned in response as { "reason": "Unauthorized" }.
404 Not Found The token generation URL or method is incorrect. This will return response as { "message": "Not Found" }. Use correct URL with GET method.
REST Web Service call using the token
Status Code Short Description Description
200 OK The request is successful. Typically returned by a GET or a POST returning information.
401 Unauthorized You are not authorized to make this call. The token is invalid or you might be using it in wrong environment. This will return the response as { 'message': 'invalid token' } or { 'message': 'wrong environment' }.
403 Token Expired The token has expired. Regenerate the token and try again. This will return response as { 'message': 'expired token' }.
403 Forbidden Action All other errors apart from above will return Forbidden Action.

Basic auth based web services calls

Status Code Short Description Description
200 OK The request is successful. Typically returned by a GET or a POST returning information.
400 Bad Request The request contained an error. This status is returned by various methods when the data provided by the client - either as a part of the URI, query parameters or the body - does not meet the server requirements.
401 Unauthorized You are not authorized to make this call. Either username or password is incorrect.
404 Not Found The requested resource was not found. This will return response as <html><body>No service was found.</body></html>.
405 Method not allowed The method requested is not allowed for the resource in the URI.
406 Not acceptable The requested media type specified in the Accept header is not supported.
409 Conflict The request could not be processed because of conflict in the request, such as the requested resource is not in the expected state, or the result of processing the request would create a conflict within the resource.
412 Precondition Failed The server does not meet one of the preconditions that the requester put on the request header fields.
415 Unsupported Media Type The request entity has a media type which the server or resource does not support.
417 Expectation Failed The server cannot meet the requirements of the Expect request-header field.
429 Too many requests Requests have exceeded agreed rate limit.
500 Forbidden You are not allowed to access the requested resource. This will return response as Access to service is denied.
500 Internal Server Error An internal error was encountered that prevents the server from processing the request and providing a valid response.
501 Not Implemented The server does not support the functionality required to fulfill the request.
503 Service unavailable The server cannot handle the request (because it is overloaded or down for maintenance). This will return response as {"message": "Service Unavailable"}. Please try again after some time.
504 Gateway Timeout The request has timed out. Please try again with smaller payload of half the records.