MapObject Operations API Endpoints

Update Site Mapobjects

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/map-objects

Description:

It deletes all existing mapobjects 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 "Mapobject".
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": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Success Response:

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

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

Update Building Mapobjects

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/map-objects

Description:

It deletes all existing mapobjects 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 "Mapobject".
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": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Success Response:

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

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

Update Level Mapobjects

Endpoint:

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

Description:

It deletes all existing mapobjects 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 "Mapobject".
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": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Success Response:

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

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

Delete Site Mapobjects

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/map-objects

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

Success Response:

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

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

Delete Building Mapobjects

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/map-objects

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

Success Response:

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

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

Delete Level Mapobjects

Endpoint:

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

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

Success Response:

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

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

Get Draft Site Mapobjects

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/map-objects

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

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

Get Draft Building Mapobjects

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/map-objects

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

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

Get Draft Level Mapobjects

Endpoint:

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

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

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

Get Published Site Mapobjects

Endpoint:

GET api/v9/content/published/clients/{clientIdentifier}/sites/{siteIdentifier}/map-objects

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

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "typeCode": "exhibition-hall",
        "fid": "239ee74e-deb1-4525-afcf-4d59d93999fe",
        "lvl": 1,
        "bid": "239ee74e-deb1-4525-afcf-4d59d93999ce",
        "sid": "239ee74e-deb1-4525-afcf-4d59d93999de",
        "name": "Exhibition Hall",
        "eid": "eid",
        "extra": {
          "exampleKey": "exampleValue"
        }
      },
      "geometry": {
        "coordinates": [
          [
            [-87.65376826, 41.88388598],
            [-87.65376875, 41.8838876],
            [-87.65376913, 41.88390733],
            [-87.65374207, 41.88390762],
            [-87.65374171, 41.88388879],
            [-87.65374169, 41.88388789],
            [-87.65375626, 41.88388774],
            [-87.65376826, 41.88388598]
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

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