Cервис позиционирования

Введение

Base URL: https://positioning.stage.odinn.cloud

Документация предоставляет всю информацию, необходимую вам для работы с нашим API.

Аутентификация запросов

Для аутентификации запросов передайте Authorization заголовок со значением "Bearer {YOUR_AUTH_KEY}".

Все аутентифицированные конечные точки помечены как requires authentication в документации ниже.

Принимается JWT токен, выданный сервисом пользователей. Вы можете получить токен пользователя с помощью этого метода.
Если используется сервисный токен, также необходимо передать заголовок X-User-ID с ID пользователя.

V1

Positions

Получить историю местоположений пользователя внутри зон

GET

https://positioning.stage.odinn.cloud

/api/v1/positions/user/{id}

requires authentication

(последние 500 точек)

Требуемые разрешения: users:positions

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

7680261c-ce29-3185-a9c0-e31ca37ca72d

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/positions/user/7680261c-ce29-3185-a9c0-e31ca37ca72d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

Получить историю местоположений текущего пользователя внутри зон

GET

https://positioning.stage.odinn.cloud

/api/v1/positions/current

requires authentication

(последние 500 точек)

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/positions/current" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

Space

GET api/v1/spaces

GET

https://positioning.stage.odinn.cloud

/api/v1/spaces

requires authentication

Требуемые разрешения: spaces:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

page

integer

Номер страницы.

Example:

page-size

integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/spaces?page=1&page-size=50" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

POST api/v1/spaces

POST

https://positioning.stage.odinn.cloud

/api/v1/spaces

requires authentication

Требуемые разрешения: spaces:create

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

width

number

required

Must be at least 1.

Example:

height

number

required

Must be at least 1.

Example:

image_offset_x

number

Example:

4379.7

image_offset_y

number

Example:

1.299751187

image_scale

number

Must be at least 0.1.

Example:

notes

string

Must not be greater than 500 characters.

Example:

zlsmiysehyvpjntngdvud

Auth

Bearer

Headers

Body

{ "name": "bf", "width": 72, "height": 77, "image_offset_x": 4379.7, "image_offset_y": 1.299751187, "image_scale": 45, "notes": "zlsmiysehyvpjntngdvud" }

Received response

Example request:

curl --request POST \
    "https://positioning.stage.odinn.cloud/api/v1/spaces" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"bf\",
    \"width\": 72,
    \"height\": 77,
    \"image_offset_x\": 4379.7,
    \"image_offset_y\": 1.299751187,
    \"image_scale\": 45,
    \"notes\": \"zlsmiysehyvpjntngdvud\"
}"

Example response:

{
    "message": "User does not have any of permissions: spaces:create"
}

PUT api/v1/spaces/{id}

PUT

https://positioning.stage.odinn.cloud

/api/v1/spaces/{id}

requires authentication

Требуемые разрешения: spaces:update

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

e73f6942-77f6-3485-99b6-7a5b419656a9

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

vyqqrq

width

number

required

Must be at least 1.

Example:

height

number

required

Must be at least 1.

Example:

image_offset_x

number

Example:

39.818

image_offset_y

number

Example:

12751817.206831

image_scale

number

Must be at least 0.1.

Example:

notes

string

Must not be greater than 500 characters.

Example:

xcoiyvywfryirewaegl

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "vyqqrq", "width": 89, "height": 73, "image_offset_x": 39.818, "image_offset_y": 12751817.2068311, "image_scale": 49, "notes": "xcoiyvywfryirewaegl" }

Received response

Example request:

curl --request PUT \
    "https://positioning.stage.odinn.cloud/api/v1/spaces/e73f6942-77f6-3485-99b6-7a5b419656a9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vyqqrq\",
    \"width\": 89,
    \"height\": 73,
    \"image_offset_x\": 39.818,
    \"image_offset_y\": 12751817.2068311,
    \"image_scale\": 49,
    \"notes\": \"xcoiyvywfryirewaegl\"
}"

Example response:

{
    "message": "User does not have any of permissions: spaces:update"
}

GET api/v1/spaces/{id}

GET

https://positioning.stage.odinn.cloud

/api/v1/spaces/{id}

requires authentication

Требуемые разрешения: spaces:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

88b35852-6778-3b80-b78a-510d22ce592d

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/spaces/88b35852-6778-3b80-b78a-510d22ce592d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

DELETE api/v1/spaces/{id}

DELETE

https://positioning.stage.odinn.cloud

/api/v1/spaces/{id}

requires authentication

Требуемые разрешения: spaces:delete

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

e8b4d1e1-f81c-3b1e-b459-4f2c309bb665

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://positioning.stage.odinn.cloud/api/v1/spaces/e8b4d1e1-f81c-3b1e-b459-4f2c309bb665" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "User does not have any of permissions: spaces:delete"
}

Загрузить карту помещения

POST

https://positioning.stage.odinn.cloud

/api/v1/spaces/{id}/image

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

6eb24a32-834e-35b2-b21a-19f15ee85fca

Body Parameters

image

string

Auth

Bearer

Headers

URL Parameters

Body

{ "image": null }

Received response

Example request:

curl --request POST \
    "https://positioning.stage.odinn.cloud/api/v1/spaces/6eb24a32-834e-35b2-b21a-19f15ee85fca/image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Записать местоположение пользователя внутри помещения.

POST

https://positioning.stage.odinn.cloud

/api/v1/spaces/{id}/position

requires authentication

Координаты измеряются в безарзмерных единицах от помещения (не от зоны). Зона находится автоматически по переданным координатам и границам зон (включительно).

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

18790e0e-0b66-3236-a009-8542d579067b

Body Parameters

number

required

Must be at least 0.

Example:

number

required

Must be at least 0.

Example:

number

Must be at least 0.

Example:

lat

number

Must be at least 0.

Example:

long

number

Must be at least 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "x": 15, "y": 30, "z": 81, "lat": 58, "long": 36 }

Received response

Example request:

curl --request POST \
    "https://positioning.stage.odinn.cloud/api/v1/spaces/18790e0e-0b66-3236-a009-8542d579067b/position" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"x\": 15,
    \"y\": 30,
    \"z\": 81,
    \"lat\": 58,
    \"long\": 36
}"

Удалить карту помещения

DELETE

https://positioning.stage.odinn.cloud

/api/v1/spaces/{id}/image

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

490e267c-f0e0-3563-85b7-8e2585efdfb0

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://positioning.stage.odinn.cloud/api/v1/spaces/490e267c-f0e0-3563-85b7-8e2585efdfb0/image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Zone

GET api/v1/zones

GET

https://positioning.stage.odinn.cloud

/api/v1/zones

requires authentication

Требуемые разрешения: zones:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

page

integer

Номер страницы.

Example:

page-size

integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/zones?page=1&page-size=50" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

POST api/v1/zones

POST

https://positioning.stage.odinn.cloud

/api/v1/zones

requires authentication

Требуемые разрешения: zones:create

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

dmlhheawfjsiubw

space

object

required

is_wifi_available

boolean

Example:

ssid

string

This field is required when is_wifi_available is true. Must not be greater than 128 characters.

Example:

mxqnafuvm

security

string

wifi_password

string

This field is required unless security is in null or none. Must not be greater than 128 characters.

Example:

yxhqjsccaawltbj

points

object[]

required

Must have at least 2 items.

color

string

Must match the regex /^#[0-9a-f]{6}$/i. Must be at least 6 characters. Must not be greater than 9 characters.

Example:

denied_duties

object[]

allowed_duties

object[]

notes

string

Must not be greater than 500 characters.

Example:

oxqaqeqrmkqpumg

Auth

Bearer

Headers

Body

{ "name": "dmlhheawfjsiubw", "space": { "id": "95b1b967-998d-37fa-b0f3-85762f275cd0" }, "is_wifi_available": true, "ssid": "mxqnafuvm", "security": null, "wifi_password": "yxhqjsccaawltbj", "points": [ { "x": 63, "y": 37, "z": 66 } ], "color": "vf", "denied_duties": [ { "id": "d565f195-f84e-34fd-9dd8-bcf7232c48df" } ], "allowed_duties": [ { "id": "8d1bae79-663a-3171-bab7-b40f812d07a8" } ], "notes": "oxqaqeqrmkqpumg" }

Received response

Example request:

curl --request POST \
    "https://positioning.stage.odinn.cloud/api/v1/zones" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dmlhheawfjsiubw\",
    \"space\": {
        \"id\": \"95b1b967-998d-37fa-b0f3-85762f275cd0\"
    },
    \"is_wifi_available\": true,
    \"ssid\": \"mxqnafuvm\",
    \"wifi_password\": \"yxhqjsccaawltbj\",
    \"points\": [
        {
            \"x\": 63,
            \"y\": 37,
            \"z\": 66
        }
    ],
    \"color\": \"vf\",
    \"notes\": \"oxqaqeqrmkqpumg\",
    \"denied_duties\": [
        {
            \"id\": \"d565f195-f84e-34fd-9dd8-bcf7232c48df\"
        }
    ],
    \"allowed_duties\": [
        {
            \"id\": \"8d1bae79-663a-3171-bab7-b40f812d07a8\"
        }
    ]
}"

Example response:

{
    "message": "User does not have any of permissions: zones:create"
}

PUT api/v1/zones/{id}

PUT

https://positioning.stage.odinn.cloud

/api/v1/zones/{id}

requires authentication

Требуемые разрешения: zones:update

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

b3f22223-9947-3e58-a735-1de6b7145fd4

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

nraafcrlpiomkk

space

object

required

is_wifi_available

boolean

Example:

ssid

string

This field is required when is_wifi_available is true. Must not be greater than 128 characters.

Example:

ztiebsvycloywht

security

string

wifi_password

string

This field is required unless security is in null or none. Must not be greater than 128 characters.

Example:

bixbtprw

points

object[]

required

Must have at least 2 items.

color

string

Must match the regex /^#[0-9a-f]{6}$/i. Must be at least 6 characters. Must not be greater than 9 characters.

Example:

emdaxia

denied_duties

object[]

allowed_duties

object[]

notes

string

Must not be greater than 500 characters.

Example:

nhzrlxqgoavvn

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "nraafcrlpiomkk", "space": { "id": "d9786f92-18ee-360b-8ccb-ec532a223d6a" }, "is_wifi_available": true, "ssid": "ztiebsvycloywht", "security": null, "wifi_password": "bixbtprw", "points": [ { "x": 7, "y": 21, "z": 13 } ], "color": "emdaxia", "denied_duties": [ { "id": "201e8c25-2561-38de-a6af-e125d74f733a" } ], "allowed_duties": [ { "id": "645068a9-dc86-30a7-aa0a-076a99f18300" } ], "notes": "nhzrlxqgoavvn" }

Received response

Example request:

curl --request PUT \
    "https://positioning.stage.odinn.cloud/api/v1/zones/b3f22223-9947-3e58-a735-1de6b7145fd4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nraafcrlpiomkk\",
    \"space\": {
        \"id\": \"d9786f92-18ee-360b-8ccb-ec532a223d6a\"
    },
    \"is_wifi_available\": true,
    \"ssid\": \"ztiebsvycloywht\",
    \"wifi_password\": \"bixbtprw\",
    \"points\": [
        {
            \"x\": 7,
            \"y\": 21,
            \"z\": 13
        }
    ],
    \"color\": \"emdaxia\",
    \"notes\": \"nhzrlxqgoavvn\",
    \"denied_duties\": [
        {
            \"id\": \"201e8c25-2561-38de-a6af-e125d74f733a\"
        }
    ],
    \"allowed_duties\": [
        {
            \"id\": \"645068a9-dc86-30a7-aa0a-076a99f18300\"
        }
    ]
}"

Example response:

{
    "message": "User does not have any of permissions: zones:update"
}

GET api/v1/zones/{id}

GET

https://positioning.stage.odinn.cloud

/api/v1/zones/{id}

requires authentication

Требуемые разрешения: zones:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

f3d6e87f-b211-3a8a-bed4-b45e0661ffc4

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/zones/f3d6e87f-b211-3a8a-bed4-b45e0661ffc4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

DELETE api/v1/zones/{id}

DELETE

https://positioning.stage.odinn.cloud

/api/v1/zones/{id}

requires authentication

Требуемые разрешения: zones:delete

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

6edc3a20-89fc-3214-89f7-3b56e0152f22

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://positioning.stage.odinn.cloud/api/v1/zones/6edc3a20-89fc-3214-89f7-3b56e0152f22" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "User does not have any of permissions: zones:delete"
}

Beacon

GET api/v1/beacons

GET

https://positioning.stage.odinn.cloud

/api/v1/beacons

requires authentication

Требуемые разрешения: beacons:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

page

integer

Номер страницы.

Example:

page-size

integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/beacons?page=1&page-size=50" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

POST api/v1/beacons

POST

https://positioning.stage.odinn.cloud

/api/v1/beacons

requires authentication

Требуемые разрешения: beacons:create

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

mac

string

required

Must match the regex /^[0-9a-f]{2}(:[0-9a-f]{2}){5}$/i. Must be 17 characters.

Example:

vgywokhgeaaxkitoe

name

string

Must not be greater than 128 characters.

Example:

usfmbddiuesgghvue

number

required

Example:

25.5

number

required

Example:

143330.8546

number

Example:

3901.43

is_mobile

boolean

Example:

color

string

Must match the regex /^#[0-9a-f]{6}$/i. Must be at least 6 characters. Must not be greater than 9 characters.

Example:

qal

space

object

Auth

Bearer

Headers

Body

{ "mac": "vgywokhgeaaxkitoe", "name": "usfmbddiuesgghvue", "x": 25.5, "y": 143330.8546, "z": 3901.43, "is_mobile": true, "color": "qal", "space": { "id": "2d363916-19b8-3e3e-90e1-42e415195496" } }

Received response

Example request:

curl --request POST \
    "https://positioning.stage.odinn.cloud/api/v1/beacons" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mac\": \"vgywokhgeaaxkitoe\",
    \"name\": \"usfmbddiuesgghvue\",
    \"x\": 25.5,
    \"y\": 143330.8546,
    \"z\": 3901.43,
    \"is_mobile\": true,
    \"color\": \"qal\",
    \"space\": {
        \"id\": \"2d363916-19b8-3e3e-90e1-42e415195496\"
    }
}"

Example response:

{
    "message": "User does not have any of permissions: beacons:create"
}

PUT api/v1/beacons/{id}

PUT

https://positioning.stage.odinn.cloud

/api/v1/beacons/{id}

requires authentication

Требуемые разрешения: beacons:update

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

2954b67a-b44b-32f9-bed9-f37ddcec3f13

Body Parameters

mac

string

required

Must match the regex /^[0-9a-f]{2}(:[0-9a-f]{2}){5}$/i. Must be 17 characters.

Example:

sqzhmcmdfegyfbgkp

name

string

Must not be greater than 128 characters.

Example:

ipo

number

required

Example:

24030.778303259

number

required

Example:

13660438.57728

number

Example:

is_mobile

boolean

Example:

color

string

Must match the regex /^#[0-9a-f]{6}$/i. Must be at least 6 characters. Must not be greater than 9 characters.

Example:

ytwuahf

space

object

Auth

Bearer

Headers

URL Parameters

Body

{ "mac": "sqzhmcmdfegyfbgkp", "name": "ipo", "x": 24030.778303259, "y": 13660438.57728, "z": 0, "is_mobile": true, "color": "ytwuahf", "space": { "id": "e6c84ce4-ed06-374a-90b5-ddf6aa8c7357" } }

Received response

Example request:

curl --request PUT \
    "https://positioning.stage.odinn.cloud/api/v1/beacons/2954b67a-b44b-32f9-bed9-f37ddcec3f13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mac\": \"sqzhmcmdfegyfbgkp\",
    \"name\": \"ipo\",
    \"x\": 24030.778303259,
    \"y\": 13660438.57728,
    \"z\": 0,
    \"is_mobile\": true,
    \"color\": \"ytwuahf\",
    \"space\": {
        \"id\": \"e6c84ce4-ed06-374a-90b5-ddf6aa8c7357\"
    }
}"

Example response:

{
    "message": "User does not have any of permissions: beacons:update"
}

GET api/v1/beacons/{id}

GET

https://positioning.stage.odinn.cloud

/api/v1/beacons/{id}

requires authentication

Требуемые разрешения: beacons:list | beacons:show

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

76d1ccb9-c6d8-3444-9fa5-c9b572dac60f

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/beacons/76d1ccb9-c6d8-3444-9fa5-c9b572dac60f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

DELETE api/v1/beacons/{id}

DELETE

https://positioning.stage.odinn.cloud

/api/v1/beacons/{id}

requires authentication

Требуемые разрешения: beacons:delete

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

082cbfe0-46e7-3f66-acf4-121f9fa6c178

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://positioning.stage.odinn.cloud/api/v1/beacons/082cbfe0-46e7-3f66-acf4-121f9fa6c178" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "User does not have any of permissions: beacons:delete"
}

Wall

Листинг для фронтенда

GET

https://positioning.stage.odinn.cloud

/api/v1/positioning/walls/{id}

requires authentication

Требуемые разрешения: walls:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

required

Идентификатор (UUID)

Example:

3e2fd214-dce8-3796-a5bb-8acd3be02eab

Query Parameters

page

integer

Номер страницы.

Example:

page-size

integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/positioning/walls/3e2fd214-dce8-3796-a5bb-8acd3be02eab?page=1&page-size=50" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

Получение всех стен помещения

GET

https://positioning.stage.odinn.cloud

/api/v1/positioning/walls/space/{uuid}

requires authentication

Требуемые разрешения: space:list | walls:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

string

required

Example:

6d22f802-6937-3761-8033-3743d929cd0e

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/positioning/walls/space/6d22f802-6937-3761-8033-3743d929cd0e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

Получение стены помещения

GET

https://positioning.stage.odinn.cloud

/api/v1/positioning/walls/wall/{uuid}

requires authentication

Требуемые разрешения: space:list | walls:list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

string

required

Example:

a800dc9b-3432-32ae-89b3-0f015e104380

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://positioning.stage.odinn.cloud/api/v1/positioning/walls/wall/a800dc9b-3432-32ae-89b3-0f015e104380" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthorized"
}

Удаление стены по id

DELETE

https://positioning.stage.odinn.cloud

/api/v1/positioning/walls/wall/{uuid}

requires authentication

Требуемые разрешения: walls:delete

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

string

required

Example:

8a1fc72b-0dd1-3452-b04a-c5ec4b7c05e0

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://positioning.stage.odinn.cloud/api/v1/positioning/walls/wall/8a1fc72b-0dd1-3452-b04a-c5ec4b7c05e0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "User does not have any of permissions: walls:delete"
}

Создание стены

POST

https://positioning.stage.odinn.cloud

/api/v1/positioning/walls

requires authentication

Требуемые разрешения: walls:create

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

space

object

required

lines

number[]

required

Example:

[1086073.661295717]

isolated

string

required

Must be one of:

Example:

thickness

number

required

Example:

11489975.780302

color

string

Must match the regex /^#[0-9a-f]{6}$/i. Must be at least 6 characters. Must not be greater than 9 characters.

Example:

Auth

Bearer

Headers

Body

{ "space": { "id": "ba268747-25f2-31eb-ba2e-5c1bf41b0133" }, "lines": [ 1086073.661295717 ], "isolated": "1", "thickness": 11489975.7803019, "color": "re" }

Received response

Example request:

curl --request POST \
    "https://positioning.stage.odinn.cloud/api/v1/positioning/walls" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"space\": {
        \"id\": \"ba268747-25f2-31eb-ba2e-5c1bf41b0133\"
    },
    \"lines\": [
        1086073.661295717
    ],
    \"isolated\": \"1\",
    \"thickness\": 11489975.7803019,
    \"color\": \"re\"
}"

Example response:

{
    "message": "User does not have any of permissions: walls:create"
}

Обновление стены

PUT

https://positioning.stage.odinn.cloud

/api/v1/positioning/walls/{uuid}

requires authentication

Требуемые разрешения: walls:update

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

string

required

Example:

075662df-517c-3e28-b2d3-b4f16f847594

Body Parameters

segments

object

required

Must have at least 1 items.

Example:

[]

lines

number[]

required

Example:

[25766.236]

isolated

string

required

Must be one of:

Example:

thickness

number

required

Example:

649140

color

string

Must match the regex /^#[0-9a-f]{6}$/i. Must be at least 6 characters. Must not be greater than 9 characters.

Example:

zgauevdgb

Auth

Bearer

Headers

URL Parameters

Body

{ "segments": [], "lines": [ 25766.236 ], "isolated": "1", "thickness": 649140, "color": "zgauevdgb" }

Received response

Example request:

curl --request PUT \
    "https://positioning.stage.odinn.cloud/api/v1/positioning/walls/075662df-517c-3e28-b2d3-b4f16f847594" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"segments\": [],
    \"lines\": [
        25766.236
    ],
    \"isolated\": \"1\",
    \"thickness\": 649140,
    \"color\": \"zgauevdgb\"
}"

Example response:

{
    "message": "User does not have any of permissions: walls:update"
}