Skip to content

Beacon Operations API Endpoints

Update Site Beacons

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/beacons

Description:

It deletes all existing beacons for the given site 'siteIdentifier', then inserts the new data provided in the request payload.

Validations
  • Request body must be in geojson format and conform to schema rules. (Click here to view schema rules)
  • TypeCode should be type of "Beacon".
  • Fid is required and must be unique.
  • Sid is required.
  • Bid is required.
  • Lvl is required.
  • SiteIdentifier given from url must match sid.

Requests:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}

Success Response:

{
  "message": "Beacons for site '{siteIdentifier}' were successfully processed."
}


* You can access the possible response codes you may encounter here.

Update Building Beacons

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/beacons

Description:

It deletes all existing beacons for the given building 'buildingIdentifier', then inserts the new data provided in the request payload.

Validations
  • Request body must be in geojson format and conform to schema rules. (Click here to view schema rules)
  • TypeCode should be type of "Beacon".
  • Fid is required and must be unique.
  • Sid is required.
  • Bid is required.
  • Lvl is required.
  • SiteIdentifier given from url must match sid.
  • BuildingIdentifier given from url must match bid.

Requests:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}

Success Response:

{
  "message": "Beacons for building '{buildingIdentifier}' were successfully processed."
}


* You can access the possible response codes you may encounter here.

Update Level Beacons

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/beacons

Description:

It deletes all existing beacons for the given level 'levelIndex', then inserts the new data provided in the request payload.

Validations
  • Request body must be in geojson format and conform to schema rules. (Click here to view schema rules)
  • TypeCode should be type of "Beacon".
  • Fid is required and must be unique.
  • Sid is required.
  • Bid is required.
  • Lvl is required.
  • SiteIdentifier given from url must match sid.
  • BuildingIdentifier given from url must match bid.
  • LevelIndex given from url must match lvl.

Request:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}

Success Response:

{
  "message": "Beacons for level '{levelIndex}' were successfully processed."
}


* You can access the possible response codes you may encounter here.

Delete Site Beacons

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/beacons

Description:
Deletes all features classified as beacon of the selected site.

Success Response:

{
  "message": "Beacons for site '{siteIdentifier}' were successfully deleted."
}


* You can access the possible response codes you may encounter here.

Delete Building Beacons

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/beacons

Description:
Deletes all features classified as beacon of the selected building.

Success Response:

{
  "message": "Beacons for building '{buildingIdentifier}' were successfully deleted."
}


* You can access the possible response codes you may encounter here.

Delete Level Beacons

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/beacons

Description:
Deletes all features classified as beacon of the selected level.

Success Response:

{
  "message": "Beacons for level '{levelIndex}' were successfully deleted."
}


* You can access the possible response codes you may encounter here.

Get Draft Site Beacons

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/beacons

Description:
Returns all draft features classified as beacon of the selected site.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.

Get Draft Building Beacons

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/beacons

Description:
Returns all draft features classified as beacon of the selected building.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.

Get Draft Level Beacons

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/beacons

Description:
Returns all draft features classified as beacon of the selected level.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.

Get Published Site Beacons

Endpoint:

GET api/v9/content/published/clients/{clientIdentifier}/sites/{siteIdentifier}/beacons

Description:
Returns published features classified as beacon of the selected site.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "ibeacon",
        "fid": "ab6c670e-421f-48a3-b7a8-fc5ee6310778",
        "lvl": 0,
        "bid": "ab6c670e-421f-48a3-b7a8-fb5ee6310778",
        "sid": "ab6c670e-421f-48a3-b7a8-fd5ee6310778",
        "eid": "eid",
        "minor": 99,
        "major": 98,
        "uuid": "67746ec0-e4e1-4bc7-b69f-086cdf12c603"
      },
      "geometry": {
        "coordinates": [0.03850703, 0.06771042],
        "type": "Point"
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.