7.3 solve-excel Endpoint

The solve-excel endpoint is used to submit scenarios to the optimiser in OLM-Excel format for load plan creation.

7.3.1 solve-excel Requests

A solve-excel request is an HTTP POST request to a URL of the following form:

https://server-name/olm/v1/solve-excel?parameters

where server-name will be provided by Opturion and parameters is described below.

The body of the POST request is an OLM-Excel workbook.

7.3.2 solve-excel Parameters

The solve-excel endpoint accepts one optional parameter. It is:

  1. format – this parameter controls whether a successful output is in OLM-JSON or OLM-Excel format. Its value should be one of “json” or “excel”. If this parameter is not present, then it defaults to “excel”.
7.3.3 solve-excel Request Example

Here is an example solve-excel request URL:

    https://demo.opturion.com/olm/v1/solve-excel?format=json

Note that in this case we are using the format parameter to make the OLM return the solution in OLM-JSON format.

7.3.4 solve-excel Responses

The following table lists all of the HTTP status codes that solve-excel specifically returns and their meaning. Any other HTTP status code returned by solve-excel that is not covered by this table has its usual meaning.

HTTP Status Code

Description

HTTP Response Body

200 (OK)

A load plan has been returned.

A OLM-JSON response object or OLM-Excel output workbook.

400 (Bad Request)

There are errors in the input or web service invocation.

The body of the HTTP response may contain an OLM-JSON response object describing any errors.

401 (Unauthorized)

Authentication (if required) failed; the client is not authorized to access the optimiser.

Empty.

429 (Too Many Requests)

May be returned if rate limiting has been applied by the server.

Empty.

500 (Internal Server Error)

Indicates that an error occurred on the server.

The body may contain a OLM-JSON response object further describing the error.