Skip to content

Beacon Geofence Operations API Endpoints

Update Site Beacon-Geofences

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/beacon-geofences

Description:

It deletes all existing beacon-geofences 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-Geofences".
  • Fid is required and must be unique.
  • Sid is required.
  • Bid is required.
  • Lvl is required.
  • SiteIdentifier given from url must match sid.
  • Each enterNotification and exitNotification object must include the following fields:
  • once: true or false
  • message: (at least default language required)
  • coolDownMinutes: if once: false, this property is mandatory (duration in minutes)

Requests:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Success Response:

{
  "message": "Beacon-geofences for site '{siteIdentifier}' were successfully processed."
}


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

Update Building Beacon-Geofences

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/beacon-geofences

Description:

It deletes all existing beacon-geofences 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-Geofences".
  • 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.
  • Each enterNotification and exitNotification object must include the following fields:
  • once: true or false
  • message: (at least default language required)
  • coolDownMinutes: if once: false, this property is mandatory (duration in minutes)

Requests:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Success Response:

{
  "message": "Beacon-geofences for building '{buildingIdentifier}' were successfully processed."
}


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

Update Level Beacon-Geofences

Endpoint:

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

Description:

It deletes all existing beacon-geofences 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-Geofences".
  • 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.
  • Each enterNotification and exitNotification object must include the following fields:
  • once: true or false
  • message: (at least default language required)
  • coolDownMinutes: if once: false, this property is mandatory (duration in minutes)

Request:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Success Response:

{
  "message": "Beacon-geofences for level '{levelIndex}' were successfully processed."
}


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

Delete Site Beacon-Geofences

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/beacon-geofences

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

Success Response:

{
  "message": "Beacon-geofences for site '{siteIdentifier}' were successfully deleted."
}


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

Delete Building Beacon-Geofences

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/beacon-geofences

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

Success Response:

{
  "message": "Beacon-geofences for building '{buildingIdentifier}' were successfully deleted."
}


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

Delete Level Beacon-Geofences

Endpoint:

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

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

Success Response:

{
  "message": "Beacon-geofences for level '{levelIndex}' were successfully deleted."
}


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

Get Draft Site Beacon-Geofences

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/beacon-geofences

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}


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

Get Draft Building Beacon-Geofences

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/beacon-geofences

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}


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

Get Draft Level Beacon-Geofences

Endpoint:

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

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}


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

Get Published Site Beacon-Geofences

Endpoint:

GET api/v9/content/published/clients/{clientIdentifier}/sites/{siteIdentifier}/beacon-geofences

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "no17",
        "eid": "eid",
        "typeCode": "beacon-geofence",
        "enterNotification": {
          "once": false,
          "message": "entered blah",
          "message_el": "greek enter",
          "message_tr_TR": "turkish enter",
          "coolDownMinutes": 30
        },
        "exitNotification": {
          "once": true,
          "message": "exited blah",
          "message_el": "greek exit",
          "message_tr_TR": "turkish exit",
          "coolDownMinutes": 30
        },
        "extra": {},
        "fid": "2c1857eb-be6e-4d4f-a328-24fee76231c1",
        "bid": "2b857eb-be6e-4d4f-a328-24fee76231c1",
        "sid": "2a1857eb-be6e-4d4f-a328-24fee76231c1",
        "lvl": 2
      },
      "geometry": {
        "coordinates": [
          [
            [
              0.03850703,
              0.06771042
            ],
            [
              0.03874183,
              0.06771099
            ],
            [
              0.0387452,
              0.06771097
            ],
            [
              0.03874524,
              0.06776459
            ],
            [
              0.03874296,
              0.06803444
            ],
            [
              0.03874296,
              0.06803849
            ],
            [
              0.03861891,
              0.06803849
            ],
            [
              0.03852766,
              0.06803799
            ],
            [
              0.03850798,
              0.06801445
            ],
            [
              0.03850703,
              0.06771042
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}


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