POST /beacons/{version}/beaconDetectionReport

This API must be used by the client app to report the beacons observed during the passenger journey - regardless of wether these beacons were actually used by the client app or not. This data is used for health monitoring of the registry. And this data can also be used by the organisation that generated it for analysis.

Verb URI Description
POST /beacons/{ver}/beaconDetectionReport Report to the registry which beacons have been observed

Path Parameters

Path Parameter Notes Example
ver API Version number 1

Usage Data Format

The json data to POST to this API is an array of objects describing the beacons detected by the app.


{  
   "airportCode":"ORD",
   "flightNumber":null,
   "flightDate":null,
   "deviceIdentifier":null,
   "beaconUsage":[  
      {  
         "uuid":"6681AFE6-E062-4B12-8535-A073EE8C3CC1",
         "majorId":1,
         "minorId":0,
         "detectionCount":5,
         "detectionTimestamp":null
      },
      {  
         "uuid":"6681AFE6-E062-4B12-8535-A073EE8C3CC1",
         "majorId":1,
         "minorId":1,
         "detectionCount":null,
         "detectionTimestamp":"2014-10-27T14:48:45.588Z"
      }
   ]
}

  • airportCode : This is the 3 letter IATA airport where the detections occurred. This is a mandatory field.

  • flightNumber : The flight number the passenger is on (e.g.AA20). This is an optional field. It may be useful for analytics when later used by the organisation that generated the report data.

  • flightDate : Used with flightNumber. To be specified in yyyy-MM-dd format. This is an optional field. It may be useful for analytics when later used by the organisation that generated the report data.

  • flightDate : A unique identifier for the device on which the detections occurred. This is an optional field. It may be useful for analytics when later used by the organisation that generated the report data.

  • beaconUsage : An array of detection events. The client app can choose to either group the detections by UUID/major/minor, or pass one array entry per detection. The preference is a trade off for the user based on data packet size and granularity of data later available to that organisation. When grouping detections, the individual timestamp of the detection is lost. In the first array entry above, 5 detections of the beacon (uuid/major/minor) 6681AFE6-E062-4B12-8535-A073EE8C3CC1/1/0 are reported in a single entry. The second array element reports just a single detection. Not that the latter also reports the detection timestamp.

The reponse will be HTTP_OK for success, otherwise a HTTP status code.