Content Management
Create Level
Endpoint:
POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels
Description:
Creates a new level under the specified building.
Validations
- Request body must be in geojson format and conform to schema rules. (Click here to view schema rules)
- Fid is required and must be unique.
- Name is required and should not be greater then 100 chars.
- ShortName is required and should not be greater then 5 chars.
- LevelType is required and must be one of the following:
office,hospital,clinic,pharmacy,department store,convenience/grocery store,mall,restaurant/shop,airport,university,high school,subway/train station,bus station,hotel,stadium / sports center,museum / art center,theme park,zoo,exhibition,conference,factory,mine,warehouse,parking garageorother. - Sid is required.
- Bid is required.
- Lvl is required.
- If eid value is given, it must be unique.
- SiteIdentifier given from url must match sid.
- BuildingIdentifier given from url must match bid.
Request:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"properties": {
"typeCode": "level-outline",
"shortName": "L0",
"levelType": "office",
"name": "LVL0",
"name_ar": "ل.ف.ل0",
"name_en": "LVL0",
"name_ar_AE": "ل.ف.ل0",
"name_tr": "LVL0",
"lvl": 0,
"eid": "ext-mah-d",
"fid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"sid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"bid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
},
"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:
{
"fid": "ae9c22e8-6ebf-4b0c-b901-41141ac5dce0"
}
Notes:
- If the eid value is null, we accept it.
- If the eid value is not provided at all, we also accept it.
- If the eid value exists and was not previously present, we accept it.
- If the eid value is an empty string (""), we do not accept it.
- If a level is added to a temporary building, the added level is also temporary.
* You can access the possible response codes you may encounter here.
Get Draft Level
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}
Description:
Returns the draft data of the selected level under the specified building.
Success Response:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"properties": {
"isTemp": true,
"typeCode": "level-outline",
"shortName": "L0",
"levelType": "office",
"name": "LVL0",
"name_ar": "ل.ف.ل0",
"name_en": "LVL0",
"name_ar_AE": "ل.ف.ل0",
"name_tr": "LVL0",
"lvl": 0,
"eid": "ext-mah-d",
"fid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"sid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"bid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
},
"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 Levels
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels
Description:
Returns draft data for all levels under the selected building.
Success Response:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"properties": {
"isTemp": true,
"typeCode": "level-outline",
"shortName": "L0",
"levelType": "office",
"name": "LVL0",
"name_ar": "ل.ف.ل0",
"name_en": "LVL0",
"name_ar_AE": "ل.ف.ل0",
"name_tr": "LVL0",
"lvl": 0,
"eid": "ext-mah-d",
"fid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"sid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"bid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
},
"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.
Update Level
Endpoint:
PUT api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}
Description:
Updates the selected level under the specified building.
Validations
- Request body must be in geojson format and conform to schema rules. (Click here to view schema rules)
- Fid is required and must be unique.
- Name is required and should not be greater then 100 chars.
- ShortName is required and should not be greater then 5 chars.
- LevelType is required and must be one of the following:
office,hospital,clinic,pharmacy,department store,convenience/grocery store,mall,restaurant/shop,airport,university,high school,subway/train station,bus station,hotel,stadium / sports center,museum / art center,theme park,zoo,exhibition,conference,factory,mine,warehouse,parking garageorother. - Sid is required.
- Bid is required.
- Lvl is required.
- If eid value is given, it must be unique.
- 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": "level-outline",
"shortName": "L0",
"levelType": "office",
"name": "LVL0",
"name_ar": "ل.ف.ل0",
"name_en": "LVL0",
"name_ar_AE": "ل.ف.ل0",
"name_tr": "LVL0",
"lvl": 0,
"eid": "ext-mah-d",
"fid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"sid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
"bid": "1c8abf58-07c7-469b-b23a-c791bedcfb19",
},
"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:
{
"fid": "ae9c22e8-6ebf-4b0c-b901-41141ac5dce0"
}
Notes:
- If the eid value is null, we accept it.
- If the eid value is not provided at all, we also accept it.
- If the eid value exists and was not previously present, we accept it.
- If the eid value is an empty string (""), we do not accept it.
* You can access the possible response codes you may encounter here.
Delete Level
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}
Description:
Deletes the selected level along with all related content data.
Success Response:
{
"message": "Level deleted successfully."
}
* You can access the possible response codes you may encounter here.