Site Zones
This Endpoint only works if the company is set to 'company_type' == 'industry'.
Get Site Zones
GET https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/zones
Get all zones of that specific site.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"zones":[
{
"uuid":"0365439b-61fe-4477-a3ce-5c92a927d4a9",
"name":"Test Zone",
"description":null,
"lat":"51.5539311",
"lng":"7.47147789",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"c3d94a348c2b57c3dde1e35f57d84606\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.471479364365877,51.55393110051256],[7.4715049000967895,51.553933237874816],[7.4715034268833165,51.553919803024286],[7.4714798554396396,51.55391888701149],[7.471479364365877,51.55393110051256]]],\"type\":\"Polygon\"}}]}",
"created_at":"2021-07-14T10:40:56.691+02:00",
"updated_at":"2021-07-14T10:40:56.691+02:00",
"area":{
"uuid":"c9c9375d-fea8-4a16-a74b-2959db54beef",
"name":"Gebäude 1",
"description":null,
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"764c7b9a3338715cc163414a1a854fbe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714634561605635,51.55393717660692],[7.4715192275419895,51.553942616198526],[7.471522508212047,51.55389433980159],[7.471472204612837,51.553893659851866],[7.4714634561605635,51.55393717660692]]],\"type\":\"Polygon\"}}]}",
"lat":"51.55393786",
"lng":"7.47146783",
"created_at":"2021-07-14T10:40:20.690+02:00",
"updated_at":"2021-07-14T10:40:20.690+02:00"
},
"zone_locations":[
{
"uuid":"945f4af4-2bd7-4bee-be85-a8a07ab598a8",
"name":"Default",
"description":null,
"fraction_override":false,
"fraction_name":null,
"containers":[
{
"uuid":"26a59a0b-1564-4197-a40f-31d4da057052",
"name":"Test #1"
},
{
"uuid":"c7fe72d5-0f8b-4c53-b56d-b5dda821c7c8",
"name":"Test #2"
}
],
"created_at":"2021-07-14T10:40:56.723+02:00",
"updated_at":"2021-07-14T10:40:56.723+02:00"
}
]
}
],
"meta":{
"pagination":{
"per_page":25,
"total_pages":1,
"total_objects":1,
"links":{
"first":"/v1/companies/2938e76d-7b1f-4c88-ab67-f0b54eac3265/sites/20815086-824e-4278-a808-d8d1bf4ae25d/zones?page=1",
"last":"/v1/companies/2938e76d-7b1f-4c88-ab67-f0b54eac3265/sites/20815086-824e-4278-a808-d8d1bf4ae25d/zones?page=1"
}
}
}
}Create Zone
POST https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/zones
Create a new site.
Headers
Name
Type
Description
Authorization
string
Bearer Token
Request Body
Name
Type
Description
name
string
The name of this zone.
image_coordinates
array
Array of coordinates.
description
string
Description of this zone.
{
"zone":{
"uuid":"0365439b-61fe-4477-a3ce-5c92a927d4a9",
"name":"Test Zone",
"description":null,
"lat":"51.5539311",
"lng":"7.47147789",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"c3d94a348c2b57c3dde1e35f57d84606\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.471479364365877,51.55393110051256],[7.4715049000967895,51.553933237874816],[7.4715034268833165,51.553919803024286],[7.4714798554396396,51.55391888701149],[7.471479364365877,51.55393110051256]]],\"type\":\"Polygon\"}}]}",
"created_at":"2021-07-14T10:40:56.691+02:00",
"updated_at":"2021-07-14T10:40:56.691+02:00",
"area":{
"uuid":"c9c9375d-fea8-4a16-a74b-2959db54beef",
"name":"Gebäude 1",
"description":null,
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"764c7b9a3338715cc163414a1a854fbe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714634561605635,51.55393717660692],[7.4715192275419895,51.553942616198526],[7.471522508212047,51.55389433980159],[7.471472204612837,51.553893659851866],[7.4714634561605635,51.55393717660692]]],\"type\":\"Polygon\"}}]}",
"lat":"51.55393786",
"lng":"7.47146783",
"created_at":"2021-07-14T10:40:20.690+02:00",
"updated_at":"2021-07-14T10:40:20.690+02:00"
},
"zone_locations":[
{
"uuid":"945f4af4-2bd7-4bee-be85-a8a07ab598a8",
"name":"Default",
"description":null,
"fraction_override":false,
"fraction_name":null,
"containers":[
{
"uuid":"26a59a0b-1564-4197-a40f-31d4da057052",
"name":"Test #1"
},
{
"uuid":"c7fe72d5-0f8b-4c53-b56d-b5dda821c7c8",
"name":"Test #2"
}
],
"created_at":"2021-07-14T10:40:56.723+02:00",
"updated_at":"2021-07-14T10:40:56.723+02:00"
}
]
}
}Get Zone
GET https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/zones/:zone_uuid
Get data of a single area.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"zone":{
"uuid":"0365439b-61fe-4477-a3ce-5c92a927d4a9",
"name":"Test Zone",
"description":null,
"lat":"51.5539311",
"lng":"7.47147789",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"c3d94a348c2b57c3dde1e35f57d84606\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.471479364365877,51.55393110051256],[7.4715049000967895,51.553933237874816],[7.4715034268833165,51.553919803024286],[7.4714798554396396,51.55391888701149],[7.471479364365877,51.55393110051256]]],\"type\":\"Polygon\"}}]}",
"created_at":"2021-07-14T10:40:56.691+02:00",
"updated_at":"2021-07-14T10:40:56.691+02:00",
"area":{
"uuid":"c9c9375d-fea8-4a16-a74b-2959db54beef",
"name":"Gebäude 1",
"description":null,
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"764c7b9a3338715cc163414a1a854fbe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714634561605635,51.55393717660692],[7.4715192275419895,51.553942616198526],[7.471522508212047,51.55389433980159],[7.471472204612837,51.553893659851866],[7.4714634561605635,51.55393717660692]]],\"type\":\"Polygon\"}}]}",
"lat":"51.55393786",
"lng":"7.47146783",
"created_at":"2021-07-14T10:40:20.690+02:00",
"updated_at":"2021-07-14T10:40:20.690+02:00"
},
"zone_locations":[
{
"uuid":"945f4af4-2bd7-4bee-be85-a8a07ab598a8",
"name":"Default",
"description":null,
"fraction_override":false,
"fraction_name":null,
"containers":[
{
"uuid":"26a59a0b-1564-4197-a40f-31d4da057052",
"name":"Test #1"
},
{
"uuid":"c7fe72d5-0f8b-4c53-b56d-b5dda821c7c8",
"name":"Test #2"
}
],
"created_at":"2021-07-14T10:40:56.723+02:00",
"updated_at":"2021-07-14T10:40:56.723+02:00"
}
]
}
}Update Zone
PATCH https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/zones/:zone_uuid
Update data of a single site.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"zone":{
"uuid":"0365439b-61fe-4477-a3ce-5c92a927d4a9",
"name":"Test Zone",
"description":null,
"lat":"51.5539311",
"lng":"7.47147789",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"c3d94a348c2b57c3dde1e35f57d84606\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.471479364365877,51.55393110051256],[7.4715049000967895,51.553933237874816],[7.4715034268833165,51.553919803024286],[7.4714798554396396,51.55391888701149],[7.471479364365877,51.55393110051256]]],\"type\":\"Polygon\"}}]}",
"created_at":"2021-07-14T10:40:56.691+02:00",
"updated_at":"2021-07-14T10:40:56.691+02:00",
"area":{
"uuid":"c9c9375d-fea8-4a16-a74b-2959db54beef",
"name":"Gebäude 1",
"description":null,
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"764c7b9a3338715cc163414a1a854fbe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714634561605635,51.55393717660692],[7.4715192275419895,51.553942616198526],[7.471522508212047,51.55389433980159],[7.471472204612837,51.553893659851866],[7.4714634561605635,51.55393717660692]]],\"type\":\"Polygon\"}}]}",
"lat":"51.55393786",
"lng":"7.47146783",
"created_at":"2021-07-14T10:40:20.690+02:00",
"updated_at":"2021-07-14T10:40:20.690+02:00"
},
"zone_locations":[
{
"uuid":"945f4af4-2bd7-4bee-be85-a8a07ab598a8",
"name":"Default",
"description":null,
"fraction_override":false,
"fraction_name":null,
"containers":[
{
"uuid":"26a59a0b-1564-4197-a40f-31d4da057052",
"name":"Test #1"
},
{
"uuid":"c7fe72d5-0f8b-4c53-b56d-b5dda821c7c8",
"name":"Test #2"
}
],
"created_at":"2021-07-14T10:40:56.723+02:00",
"updated_at":"2021-07-14T10:40:56.723+02:00"
}
]
}
}Delete Zone
DELETE https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/zone/:zone_uuid
Delete a single zone.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"deleted": true
}Last updated
Was this helpful?