Request

This page details the basis of a command request against the API.

HTTP

POST /{languageCode}/{companyNumber}/api/v1/{module}/{namespace}/{command} HTTP/1.1
Host: {host}:8001
Content-Type: application/json
Cache-Control: no-cache
Accept: application/json
X-Monitor-SessionId: {sessionId}

{body}

Parameters

{languageCode}

The language code of the language that you want to scope the command execution to.

{companyNumber}

The number of the Monitor ERP company that you want to invoke the command on.

{module}

The API module that the command belongs to.

{namespace}

The API namespace that the command belongs to.

{command}

The name of the command that you want to invoke.

{host}

The host where the Monitor ERP server is located.

{sessionId}

The session identifier that you received upon authentication against the API.

{body}

The JSON-encoded representation of the command request that you want to execute.

Many

If you want to send more than one command of the same type, you can append the command request URL with /Many and set the body as a JSON-encoded array of the command objects that you want to invoke.

These commands will all be executed within the same transaction by the API.

Simulate/Validate

A "many"-request can also be simulated or validated like an ordinary request by appending /Many/Simulate or /Many/Validate after the command request URL.

See Simulate/Validate for more information.