Entity Information
Data type: IncomingMessage, fields list1. Get single incoming message by id
URL: /api/messages/incoming/{messageId}[?includechilddivisions={true|false}][&includedisabledterminals={true|false}]
Description
Returns a specific incoming message by its ID if it is in the corresponding division.
| Query parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| includechilddivisions | No | True/False | False | If set to true, search message of subdivisions assets as well. Default is false. |
| includedisabledterminals | No | True/False | False | If set to true, search message of disabled terminals as well. Default is false. |
2. Get incoming messages
URL: /api/messages/incoming[?assetid={assetId}][&terminalid={terminalId}][&includechilddivisions={true|false}][&includedisabledterminals={true|false}][&startdatetime={yyyy-MM-ddTHH:mm:ssZ}][&enddatetime={yyyy-MM-ddTHH:mm:ssZ}][&afterId={incomingMessageId}]
Description
Returns all of the incoming messages that matches query parameters up to the query maximum for your division.
Sort order: reverse chronological (using CreatedOn property)
| Query parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| assetId | No | Numeric | - | Return incoming messages for all terminals of specific asset only. |
| terminalId | No | Numeric | - | Return incoming messages for specific terminal only. |
| includechilddivisions | No | True/False | False | If set to true, returns messages of subdivisions assets as well. Default is false. |
| includedisabledterminals | No | True/False | False | If set to true, returns also messages of disabled terminals. Default is false. |
| startdatetime | No | Datetime | - | If set, returns only incoming messages received at specified Date/Time or after it. Both UTC and local dates are accepted. Check Dates Handling for details. |
| enddatetime | No | Datetime | - | If set, returns only incoming messages received at specified Date/Time or before it. Both UTC and local dates are accepted. Check Dates Handling for details. |
| afterId | No | Numeric | - | Return incoming messages with Id more than specified parameter value. |