Site Areas
This Endpoint only works if the company is set to 'company_type' == 'industry'.
Get Site Areas
GET https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/areas
Get all areas of that specific site.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"areas":[
{
"uuid":"81a92115-8441-49a5-a6b5-9ecb8d1d90bb",
"name":"Area 51",
"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",
"site":{
"uuid":"a80c72fa-621e-4ac9-80d7-3b14d57b8381",
"name":"Test",
"description":"",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"ec31efc798307cba54af561a00d874fe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114],[7.4714428259425745,51.553947348620795]]],\"type\":\"Polygon\"}}]}","lat":"51.55394735","lng":"7.47145698","zoom":17,"image":"/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBb0VSIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ebecb7a9a2195e9074274e03f97d7caeacb841a4/Pilkington2-Deckkraft100.jpg","image_coordinates":"[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114]]",
"rotated":true,
"uploaded":true,
"created_at":"2021-07-14T10:39:22.198+02:00",
"updated_at":"2021-07-14T10:39:56.872+02:00"
},
"zones":[
{
"uuid":"82bfedc0-2d81-4b6c-95fe-170b5fef7ebd",
"name":"Test",
"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"
}
]
}
],
"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/areas?page=1",
"last":"/v1/companies/2938e76d-7b1f-4c88-ab67-f0b54eac3265/sites/20815086-824e-4278-a808-d8d1bf4ae25d/areas?page=1"
}
}
}
}Create Area
POST https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/areas
Create a new site.
Headers
Name
Type
Description
Authorization
string
Bearer Token
Request Body
Name
Type
Description
name
string
The name of this area.
image_coordinates
array
Array of coordinates.
description
string
Description of this area.
{
"area":{
"uuid":"81a92115-8441-49a5-a6b5-9ecb8d1d90bb",
"name":"Area 51",
"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",
"site":{
"uuid":"a80c72fa-621e-4ac9-80d7-3b14d57b8381",
"name":"Test",
"description":"",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"ec31efc798307cba54af561a00d874fe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114],[7.4714428259425745,51.553947348620795]]],\"type\":\"Polygon\"}}]}","lat":"51.55394735","lng":"7.47145698","zoom":17,"image":"/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBb0VSIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ebecb7a9a2195e9074274e03f97d7caeacb841a4/Pilkington2-Deckkraft100.jpg","image_coordinates":"[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114]]",
"rotated":true,
"uploaded":true,
"created_at":"2021-07-14T10:39:22.198+02:00",
"updated_at":"2021-07-14T10:39:56.872+02:00"
},
"zones":[
{
"uuid":"82bfedc0-2d81-4b6c-95fe-170b5fef7ebd",
"name":"Test",
"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"
}
]
}
}Get Area
GET https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/areas/:area_uuid
Get data of a single area.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"area":{
"uuid":"81a92115-8441-49a5-a6b5-9ecb8d1d90bb",
"name":"Area 51",
"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",
"site":{
"uuid":"a80c72fa-621e-4ac9-80d7-3b14d57b8381",
"name":"Test",
"description":"",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"ec31efc798307cba54af561a00d874fe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114],[7.4714428259425745,51.553947348620795]]],\"type\":\"Polygon\"}}]}","lat":"51.55394735","lng":"7.47145698","zoom":17,"image":"/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBb0VSIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ebecb7a9a2195e9074274e03f97d7caeacb841a4/Pilkington2-Deckkraft100.jpg","image_coordinates":"[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114]]",
"rotated":true,
"uploaded":true,
"created_at":"2021-07-14T10:39:22.198+02:00",
"updated_at":"2021-07-14T10:39:56.872+02:00"
},
"zones":[
{
"uuid":"82bfedc0-2d81-4b6c-95fe-170b5fef7ebd",
"name":"Test",
"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"
}
]
}
}Update Area
PATCH https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/areas/:area_uuid
Update data of a single site.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"area":{
"uuid":"81a92115-8441-49a5-a6b5-9ecb8d1d90bb",
"name":"Area 51",
"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",
"site":{
"uuid":"a80c72fa-621e-4ac9-80d7-3b14d57b8381",
"name":"Test",
"description":"",
"mb_feature_polygon":"{\"type\":\"FeatureCollection\",\"features\":[{\"id\":\"ec31efc798307cba54af561a00d874fe\",\"type\":\"Feature\",\"properties\":{},\"geometry\":{\"coordinates\":[[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114],[7.4714428259425745,51.553947348620795]]],\"type\":\"Polygon\"}}]}","lat":"51.55394735","lng":"7.47145698","zoom":17,"image":"/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBb0VSIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ebecb7a9a2195e9074274e03f97d7caeacb841a4/Pilkington2-Deckkraft100.jpg","image_coordinates":"[[7.4714428259425745,51.553947348620795],[7.4715843426321555,51.55395966748398],[7.471618306636827,51.55366577369577],[7.471476789948014,51.553658734300114]]",
"rotated":true,
"uploaded":true,
"created_at":"2021-07-14T10:39:22.198+02:00",
"updated_at":"2021-07-14T10:39:56.872+02:00"
},
"zones":[
{
"uuid":"82bfedc0-2d81-4b6c-95fe-170b5fef7ebd",
"name":"Test",
"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"
}
]
}
}Delete Area
DELETE https://api.binity.io/v1/companies/:uuid/sites/:site_uuid/areas/:area_uuid
Delete a single area.
Headers
Name
Type
Description
Authorization
string
Bearer Token
{
"deleted": true
}Last updated
Was this helpful?