Request

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

HTTP

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

POST queries

The body of the POST query request must be a URL-encoded string of Query options

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

{body}

Parameters

{languageCode}

The language code of the language that you want any translatable data translated as.

{companyNumber}

The number of the Monitor ERP company that you want to query data from.

{module}

The API module that the queryable entity belongs to.

{entity}

The name of the entity that you want to query.

{id?}

The business key of the entity that you want to query.

Note: This segment is optional and can be left out in order to query the entire data set.

{host}

The host where the Monitor ERP server is located.

{sessionId}

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