You are here: Home / 2013 / Июль / 01 / mapSurfer — rest — groups

mapSurfer — rest — groups

1 июля 2013 admin
назад
mapSurfer GS / Руководство разработчика REST / Группы слоев

GET /groups

Структура запроса:


GET /groups?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "groups": [
        {
            "id": 32,
            "name": "Группа 1",
            "order": "1"
        }
    ]
}





// массив объектов с информацией по группе

// id группы, целое число
// название группы, строка
// порядковый номер группы в списке, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /groups/withLayers

Список групп, включая полную информацию по принадлежащим им слоям

Структура запроса:


GET /groups/withLayers?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "groups": [
        {
            "id": 32,
            "name": "Группа1",
            "order": "1",
            "groupLayers": [
                {
                    "layer": {
                        "id": 10,
                        "name": "Слой 1",
                        "enabled": false,
                        "info": {
                            "id": 10,
                            "typeName": "test:test_layer",
                            "style": "test_layer_a",
                            "service": "WMS",
                            "poly": false,
                            "requestUrl": "/service/wms"
                        },
                        "fields": [
                            {
                                "id": 4076,
                                "name": "adm_znach",
                                "nameRu": "Поле 1Œ",
                                "order": 1,
                                "title": false
                            }
                        ],
                        "isKosmosnimok": false
                    },
                    "order": 1,
                    "groupId": 32
                }
            ]
        }
    ]
}





// массив групп
// объект
// id группы, целое число
// название группы, строка
// порядковый номер группы, целое число
// массив слоев

// информация по слою, объект
// id слоя, целое число
// русское название слоя, строка
// включен ли слой по умолчанию, булевое поле
// информация по слою, объект
// id слоя, целое число
// английское название слоя, строка
// название стиля, строка
// тип сервиса, WMS/WFS
// является ли полигоном, булевое поле
// url для запроса, строка

// массив полей
// объект поля
// id поля, целое число
// английское название поля, строка
// русское название поля , строка
// порядок следования в списке, целое число
// является ли заголовком, булевое поле


// является ли космоснимком, булевое поле

// порядок слоя в списке, целое число
// id группы

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /groups/shortdata/withLayers

Список групп, включая краткую информацию по принадлежащим им слоям

Структура запроса:


GET /groups/shortdata/withLayers?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "groups": [
        {
            "id": 32,
            "name": "Группа1",
            "order": "1",
            "groupLayers": [
                {
                    "layer": {
                        "id": 10,
                        "name": "Слой 1",
                        "enabled": false,
                        "info": {
                            "id": 10,
                            "typeName": "test:test_layer",
                            "style": "test_layer_a",
                            "service": "WMS",
                            "poly": false,
                            "requestUrl": "/service/wms",
                        },
                    },
                    "order": 1,
                    "groupId": 32
                }
            ]
        }
    ]
}





// массив групп
// объект
// id группы, целое число
// название группы, строка
// порядковый номер группы, целое число
// массив слоев

// информация по слою, объект
// id слоя, целое число
// русское название слоя, строка
// включен ли слой по умолчанию, булевое поле
// информация по слою, объект
// id слоя, целое число
// английское название слоя, строка
// название стиля, строка
// тип сервиса, WMS/WFS
// является ли полигоном, булевое поле
// url для запроса, строка


// порядок слоя в списке, целое число
// id группы

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /groups

Структура запроса:


GET /groups?name=Пункт&token=bw3ty3h46yth

name: слово/фраза, которая входит в название списка групп

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "groups": [
        {
            "id": 32,
            "name": "Группа 1",
            "order": "1"
        }
    ]
}





// массив объектов с информацией по группе

// id группы, целое число
// название группы, строка
// порядковый номер группы в списке, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /groups/withLayers

Поиск списка групп, включая полную информацию по принадлежащим им слоям

Структура запроса:


GET /groups/withLayers?name=Пункт&token=bw3ty3h46yth

name: слово/фраза, которая входит в название списка групп

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "groups": [
        {
            "id": 32,
            "name": "Группа1",
            "order": "1",
            "groupLayers": [
                {
                    "layer": {
                        "id": 10,
                        "name": "Слой 1",
                        "enabled": false,
                        "info": {
                            "id": 10,
                            "typeName": "test:test_layer",
                            "style": "test_layer_a",
                            "service": "WMS",
                            "poly": false,
                            "requestUrl": "/service/wms"
                        },
                        "fields": [
                            {
                                "id": 4076,
                                "name": "adm_znach",
                                "nameRu": "Поле 1Œ",
                                "order": 1,
                                "title": false
                            }
                        ],
                        "isKosmosnimok": false
                    },
                    "order": 1,
                    "groupId": 32
                }
            ]
        }
    ]
}





// массив групп
// объект
// id группы, целое число
// название группы, строка
// порядковый номер группы, целое число
// массив слоев

// информация по слою, объект
// id слоя, целое число
// русское название слоя, строка
// включен ли слой по умолчанию, булевое поле
// информация по слою, объект
// id слоя, целое число
// английское название слоя, строка
// название стиля, строка
// тип сервиса, WMS/WFS
// является ли полигоном, булевое поле
// url для запроса, строка

// массив полей
// объект поля
// id поля, целое число
// английское название поля, строка
// русское название поля , строка
// порядок следования в списке, целое число
// является ли заголовком, булевое поле


// является ли космоснимком, булевое поле

// порядок слоя в списке, целое число
// id группы

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /groups/{groupId}

Структура запроса:


GET /groups/224?token=bw3ty3h46yth

groupId: id группы

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    group: {
        id: 32,
        name: "Базовые слои",
        order: "1"
    }
}





// группа, объект
// id группы, целое число
// название группы, строка
// порядок группы в списке

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /groups/{groupId}/withLayers

Группа слоев, включая полную информацию по принадлежащим ей слоям

Структура запроса:


GET /groups/224/withLayers?token=bw3ty3h46yth

groupId: id группы

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


{
    "group": {
        "id": 32,
        "name": "Населенные пункты",
        "order": "1",
        "groupLayers": [
            {
                "layer": {
                    "id": 10,
                    "name": "Населенные пункты",
                    "enabled": false,
                    "info": {
                        "id": 10,
                        "typeName": "test:test_a",
                        "style": "style_test__a",
                        "service": "WMS",
                        "poly": true,
                        "requestUrl": "/service/wms"
                    },
                    "fields": [
                        {
                            "id": 4076,
                            "name": "test",
                            "nameRu": "Поле1",
                            "order": 1,
                            "title": true
                        }
                    ],
                    "isKosmosnimok": false
                },
                "order": 1,
                "groupId": 32
            }
        ]
    }
}





// группа, объект
// id группы, целое число
// название группы, строка
// порядковый номер группы, целое число
// массив слоев

// информация по слою, объект
// id слоя, целое число
// русское название слоя, строка
// включен ли слой по умолчанию, булевое поле
// информация по слою, объект
// id слоя, целое число
// английское название слоя, строка
// название стиля, строка
// тип сервиса, WMS/WFS
// является ли полигоном, булевое поле
// url для запроса, строка

// массив полей
// объект поля
// id поля, целое число
// английское название поля, строка
// русское название поля , строка
// порядок следования в списке, целое число
// является ли заголовком, булевое поле


// является ли космоснимком, булевое поле

// порядок слоя в списке, целое число
// id группы

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Posted in