Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • message_trace_id - system message-id;

  • occupied - parking occupancy status ("occupied" or "free");

  • parking_session_iterator - short serial number of parking session. Iterator (number) is incrementing when new parking session starts (0-7);

  • previous_status_duration_min - duration of previous sensor status;

Expand
titleposition Device Info
  • device_id - device id hexadecimal

  • network_id - parking space network address;

  • custom_id - a property "custom_id" of a position;

  • latitude, longitude - GPS coordinates;

  • group_inner_id - a device number inside of a parking bay;

  • group

    • id - id of a parking bay;

    • name - name of a position’s group;

    • zone_id - id of a group’s zone.

...

The message is sent to confirm the health status of a sensor every 3 hours in case of unchanged occupancy status.

Method: PUT/POST

Template Body: 

Code Block
languagejson
{
  "timestampmessage_type": "2019-10-01T18:59:11.254Zheartbeat",
  "message_typetrace_id": "heartbeat{message_trace_id}",
  "messageparking_tracesession_iditerator": "6c53ce93-27b3-40e4-b012-e4c3d3aea651"{parsed["parking_session_iterator"]},
  "messageoccupied": "{"occupied" if parsed["occupation_status"] is {True else "free"}",
  "positionheartbeat_networkmessage_id counter": "6eb6d7d6-e486-45ff-a801-058765e2522a"{heartbeat_message_counter},
    "heartbeatdevice_numberid": 3,
"{device_id}",
   "statusposition":{
"free",      "sessionnetwork_iteratorid": 1"{network_id}",
  },    "locationcustom_id": "{custom_id}",
  {      "latitude": -12.2334134{latitude},
      "longitude": 53.743789,{longitude},
      "levelgroup_inner_id": 3{group_inner_id},
   },   "groupinggroup":{
   {       "zone_id": 632{group_id},
     "group_id": 10365,      "group_name": "Position {group _name}",
     "group_inner_id": 16,      "customzone_id": "Position custom ID"
 {zone_id}
      }
  }
}

...

...

position_network_id - parking space network address;

...

heartbeat_number - the value increases for every following heartbeat during single occupancy state (0-11);

...

status - parking occupancy status ("occupied" or "free");

...

session_iterator - short number of parking session. Iterator is incrementing when parking session starts (0-7);

Expand
titleposition
  • position

    • network_id - parking space network address;

    • custom_id - a property "custom_id" of a position;

    • latitude, longitude - GPS coordinates;

    • group_inner_id - a device number inside of a parking bay;

    • group

      • id - id of a parking bay;

      • name - name of a position’s group;

      • zone_id - id of a group’s zone.

...

titleTemplate body
Expand
titleExample Message
Code Block
languagejson

...

{

...


...

   "message_type":

...

"heartbeat",
   "message_trace_id":

...

"5443685e-e8d9-410f-bcee-d2d82c2e8473",
   "

...

parking_session_iterator": 

...

5,
   "

...

occupied": "

...

free",
  

...

 

...

"heartbeat_message_counter"

...

: 2,
   

...

"

...

device_id": "

...

1E554",
   "position":{
      "network_id":"00000000-0000-0000-0000-00000001e554",
      "

...

custom_

...

id":

...

"

...

"

...

,
  

...

    "

...

latitude":51.49442797732277,
   

...

   

...

"

...

longitude":

...

-0.1280093119192549,
      "

...

group_inner_id":1,

...

      "

...

group":{

...

      

...

   "

...

id":4121,
   

...

      "

...

name":

...

"Test Group Delete After 26/02/2021",
         "

...

zone_id":

...

2779
     

...

 

...

}

...


   

...

}
}
  • message_trace_id - system message-id;

  • parking_session_iterator - short number of parking session. Iterator is incrementing when parking session starts (0-7);

  • occupied - parking occupancy status ("occupied" or "free");

  • heartbeat_message_counter - the value increases for every following heartbeat during single occupancy state (0-11);

Expand
titleDevice Info
  • device_id - device id hexadecimal

  • network_id - parking space network address;

  • custom_id - a property "custom_id" of a position;

  • latitude, longitude - GPS coordinates;

  • group_inner_id - a device number inside of a parking bay;

  • group

    • id - id of a parking bay;

    • name - name of a position’s group;

    • zone_id - id of a group’s zone.

User Registration (SDI Tag)

The message is sent to inform that a user has checked using an SDI tag.

Method: PUT/POST

Template Body:

Code Block
{
  "timestampmessage_type": "2019-10-01T18:59:11.254Zuser_registration",
  "message_typeoccupied": "{"status_сhangeoccupied", if  parsed["messageoccupation_trace_id": "6c53ce93-27b3-40e4-b012-e4c3d3aea651status"] is True else "free"}",
  "messageauth_ble_tag":    {

    "positiontag_network_id": "6eb6d7d6-e486-45ff-a801-058765e2522astring",
     "sdievent_tag_idtime": "occupied",string" #message_time or received_time
  },
  "previous_status_duration_min":36,device_id": "{device_id}",
  "position":{
      "sessionnetwork_iteratorid": 1"{network_id}",
   },   "locationcustom_id":    {"{custom_id}",
      "latitude": -12.2334134,{latitude},
      "longitude": 53.743789,{longitude},
      "levelgroup_inner_id": 3{group_inner_id},
   },   "groupinggroup":{
    {      "zone_id": 632{group_id},
     "group_id": 10365,      "group_name": "Position {group _name}",
     "group_inner_id": 16,      "customzone_id": "Position custom ID"
 {zone_id}
      }
  }
}
Expand
titleExample Message
Code Block
languagejson
  • message_trace_id - system message-id;

  • position_network_id - parking space network address;

  • new_status - parking occupancy status ("occupied" or "free");

  • sdi_tag_id - an ID of Bluetooth tag which was used for authorization;

  • session_iterator - short serial number of parking session. Iterator (number) is incrementing when new parking session starts (0-7);

position
Expand
titleposition
Device Info
  • device_id - device id hexadecimal

  • network_id - parking space network address;

  • custom_id - a property "custom_id" of a position;

  • latitude, longitude - GPS coordinates;

  • group_inner_id - a device number inside of a parking bay;

  • group

    • id - id of a parking bay;

    • name - name of a position’s group;

    • zone_id - id of a group’s zone.

Expand
titleTemplate body
Code Block
languagejson
{
  "timestamp": "{iso8601(message_time)}",
  "message_type": "status_сhange",
  "message_trace_id": "{message_trace_id}",
  "message":
   {
     "position_network_id": "{network_id}",
     "new_status": "{"occupied" if parsed["occupation_status"] is True else "free"}",
     "sdi_tag_id":{parsed["user_ID"]},
     "session_iterator": {parsed["parking_session_iterator"]}
   },
  "location":
   {
     "latitude": {latitude},
     "longitude": {longitude},
     "level": {level}
   },
  "grouping":
   {
     "zone_id": {zone_id},
     "group_id": {group_id},
     "group_name": "{group_name}",
     "group_inner_id": {group_inner_id},
     "custom_id": "{custom_id}"
   }
}

...