ROSE Developers - Web API Reference

Shipping | Indicator

[temp service].

Overview


URL api/{tenantKey}/{orgKey}/shipping/indicators
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Indicators By Code

Custom operation 'GetIndicatorsByCode'.

The following elements are required:

codes (string) Codes.

Response:

When successful, the response body contains a list of resources of type 'Indicator'. See Indicator.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /shipping/indicators/getIndicatorsByCode

GET Get Indicator By Code

Custom operation 'GetIndicatorByCode'.

The following elements are required:

code (string) Code.

Response:

When successful, the response body contains a resource of type 'Indicator'. See Indicator.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /shipping/indicators/getIndicatorByCode

Resources


Indicator

The following elements are required:

caption (string) Caption.
value (decimal) Value.
trend (int) Trend.
actual (decimal) Actual.
variation (decimal) Variation.
periodLink (string) Period Link.
actualLink (string) Actual Link.
periodCaption (string) Period Caption.
kpi (int) Kpi.

The following elements are optional:

period (decimal) Period.