Entity Information

Data type: IncomingMessage, fields list

URL: /api/messages/incoming

HTTP Method: POST

To send incoming message to the Trakopolis you need to pass following values:

  • CreatedOn: Datetime of message creation. UTC only
  • Message: Message text
  • Status: Information about your current position. Status.Latitude and Status.Longitude are recommended to be filled with valid coordinates. Status.MessageCode field should be equal to "Text Message"
  • Terminal: Information about terminal. Either Terminal.Id or Terminal.SerialNumber should be filled.

There is a delay before message becomes available on the Trakopolis website and API server. The Trakopolis API server returns ApiStatusResult response if message is added successfully (Error code = NoError) or custom error code if an error has ocurred. Some errors may cause 4xx Http status code result. Please refer to the "Error Handling" section

Remarks

Json-based request example:

Copy 
{
   "Message": "API client test message for terminal ID=123456789",
   "CreatedOn": "2013-01-01T00:00:00.0000000Z",
   "Terminal": {
     "Id": 123456789
   },
   "Status": {
     "Latitude": 51.04917,
     "Longitude": -114.06083,
     "MessageCode": "Text Message"
   }
 }