Introduction

Welcome to SEKO Worldwide's RESTful Web API Portal. Here you will find help and information about the interfaces that we expose to our customers.

Unless otherwise noted, our API's support both XML and JSON representations. The desired representation can be requested through the HTTP "Accept" Header.

In General all API's will return the structure specified in the response only if a HTTP 200 - OK response is given (or other 200 range responses e.g. 204 - No Content for success with an empty body in the response). All other HTTP response codes will be accompanied by a response body structure as detailed HERE.

An Explanation of HTTP Failure Response codes:

HTTP 413 Request Entity Too Large: This is rare - but it indicates that the request exceeds a threshold that was implemented for the specified service.
HTTP 401 Unauthorized: User Credential was missing or not accepted, or an attempt was made to access data that was secured and inaccessible to the provided user credential.
HTTP 405 Method Not Allowed: Serialization failed or implemented business logic violation occurred while processing the request. See the response body for details about the failure.
HTTP 500 Internal Server Error: An unhandled error occurred. If the problem is persistent please contact SEKO for assistance in resolving the issue. The response Body should contain an error reference that will be useful in diagnosing the problem.
All Other HTTP Codes: The server may respond to requests with response codes unrelated to the application or implementation (e.g. 415 Unsupported Media Type), which will need to be resolved on a case by case basis.