7.1 Overview

This section describes the OLM web service. The web service lets clients send scenarios to the OLM over a HTTP/1.1 connection. Results are sent back to the client over the same HTTP connection.

Optimisation scenarios may be sent as either an OLM-JSON optimise request object or as an OLM-Excel workbook.

Checking scenarios can only be sent as an OLM-JSON check request object. (Excel input is not currently supported when checking.)

Optimisation results can be returned as either OLM-JSON or OLM-Excel as specified by the client.

Checking results can currently only be returned as OLM-JSON.

The web service has the following endpoints:

  1. solve-json – submit an OLM-JSON scenario to the OLM for load plan optimisation.
  2. solve-excel – submit an OLM-Excel scenario to the OLM for load plan optimisation.
  3. check-json – submit an OLM-JSON scenario containing a load plan to the OLM for constraint checking.

Opturion will provide authentication credentials for use with the web service if required.