Map layer¶

API path: /map_layer.

Map layer object structure:¶

{
    "id": 123456,
    "label": "test"
}

• id - int. Map layer entity ID.
• label - string. Map layer name.

API actions¶

read¶

Reads the body of the specified layer.

parameters¶

examples¶

curl -X POST 'https://api.navixy.com/v2/fsm/map_layer/read' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "id": "123456"}'

https://api.navixy.com/v2/fsm/map_layer/read?hash=a6aa75587e5c59c32d347da438505fc3&id=123456

response¶

Layer body with content-type: application/vnd.google-earth.kml+xml; charset=utf-8.

errors¶

• 201 (Not found in the database) – if there is no map layer with such ID belonging to current user.

list¶

Returns metadata for all map layers for the user.

examples¶

curl -X POST 'https://api.navixy.com/v2/fsm/map_layer/list' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b"}'

https://api.navixy.com/v2/fsm/map_layer/listd?hash=a6aa75587e5c59c32d347da438505fc3

response¶

{
  "success": true,
  "list": [{
    "id": 123456,
    "label": "test"
  }]
}

errors¶

No specific errors.

upload¶

Uploads new map layer.

MUST be a POST multipart request (multipart/form-data), with one of the parts being a KML file upload (with the name "file").

parameters¶

response¶

{
    "success": true,
    "id": 163
}

• id - int. ID of the created layer.

errors¶

• 233 (No data file) – if file part is missing.
• 234 (Invalid data format) – if file has wrong mime type.
• 242 (Validation error) – if uploaded file is not valid KML.
• 268 (Over quota) – if the user's quota for map layers exceeded.

update¶

Updates metadata for the specified map layer.

parameters¶

response¶

{ "success": true }

errors¶

• 201 (Not found in the database) – if there is no map layer with such ID belonging to current user.

delete¶

Deletes specified layer.

parameters¶

examples¶

curl -X POST 'https://api.navixy.com/v2/fsm/map_layer/delete' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "id": "123456"}'

https://api.navixy.com/v2/fsm/map_layer/delete?hash=a6aa75587e5c59c32d347da438505fc3&id=123456

response¶

{ "success": true }

errors¶

• 201 (Not found in the database) – if there is no map layer with such ID belonging to current user.