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

mapSurfer — rest — layers

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

GET /layers

Список слоев с полной информацией

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

Получение списка слоев:


GET /layers?token=bw3ty3h46yth

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

Получение списка слоев по английскому названию:


GET /layers?name=test:test_a&token=bw3ty3h46yth

name: английское название слоя или слово, встречающееся в названии списка слоев

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

Ответ:

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

Формат: json


{
    "layers": [
        {
        "layer": {
            "id": 136,
            "name": "Тестовый слой",
            "enabled": false,
            "info": {
                "id": 136,
                "typeName": "test:test_a",
                "style": "test_a_style",
                "service": "WMS",
                "poly": true,
                "requestUrl": "/service/wms",
                "eisInfo": {
                    "hasEis": false,
                    "pkField": ""
                }
            },
            "fields": [
                {
                    "id": 4423,
                    "name": "vid",
                    "nameRu": "Поле 1",
                    "order": 1,
                    "title": false
                }
            ],
            "isKosmosnimok": false
        },
        "order": 2,
        "groupId": 14
        }
    ]
}





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


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


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

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

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

Формат: text/plain

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

GET /layers/{layerId}

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


GET /layers/132?token=bw3ty3h46yth

layerId: id слоя

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

Ответ:

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

Формат: json


{
    "layer": {
        "layer": {
            "id": 136,
            "name": "Тестовый слой",
            "enabled": false,
            "info": {
                "id": 136,
                "typeName": "test:test_p",
                "style": "test_p_style",
                "service": "WMS",
                "poly": false,
                "requestUrl": "/service/wms",
                "eisInfo": {
                    "hasEis": false,
                    "pkField": ""
                }
            },
            "fields": [
                {
                    "id": 4423,
                    "name": "vid",
                    "nameRu": "Поле 1",
                    "order": 1,
                    "title": false
                }
            ],
            "isKosmosnimok": false
        },
        "order": 2,
        "groupId": 14
    }
}





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


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


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

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

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

Формат: text/plain

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

GET /layers/{layerId}/info

Информация по слою, исключая данные о группе слоя

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


GET /layers/132/info?token=bw3ty3h46yth

layerId: id слоя

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

Ответ:

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

Формат: json


{
    "layer": {
        "id": 136,
        "name": "Тестовый слой",
        "enabled": false,
        "info": {
            "id": 136,
            "typeName": "test:test_p",
            "style": "test_p_style",
            "service": "WMS",
            "poly": false,
            "requestUrl": "/service/wms",
            "eisInfo": {
                "hasEis": false,
                "pkField": ""
            }
        },
        "fields": [
            {
                "id": 4423,
                "name": "vid",
                "nameRu": "Поле1",
                "order": 1,
                "title": false
            }
        ],
        "isKosmosnimok": false
    }
}





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


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


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

Статус: 404 — слой не найден в системе

Формат: text/plain

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

Статус: 403 — у вас нет доступа к данному слою

Формат: text/plain

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

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

Формат: text/plain

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

GET /layers/{layerId}/bbox

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


GET /layers/199/bbox?token=bw3ty3h46yth

layerId: id слоя

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

Ответ:

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

Формат: json


{
    boundingBox: {
        minx: "49.053",
        maxx: "49.24",
        miny: "55.739",
        maxy: "55.863",
        crs: "EPSG:4326"
    }
}





// объект
// минимальный x, число с плавающей точкой
// минимальный y, число с плавающей точкой
// максимальный x, число с плавающей точкой
// максимальный y, число с плавающей точкой
// код проекции, строка

Статус: 404 — слой не найден

Формат: text/plain

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

Статус: 403 — нет доступа к данному слою

Формат: text/plain

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

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

Формат: text/plain

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

GET /layers/{layerId}/metadata

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


GET /layers/199/metadata?token=bw3ty3h46yth

layerId: id слоя

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

Ответ:

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

Формат: json


{
    metadata: {
        id: 179,
        owner: "dhedheh",
        dataCreate: "2011.12.28 09.47",
        dataUpdate: "2011.12.28 09.47",
        itemsCount: 45,
        type: {
            id: 1,
            name: "Космоснимки",
            fieldList: [
                {
                    id: 1,
                    name: "Облачность",
                    order: 1,
                    inTable: true,
                    inTableName: "clouds",
                    fieldType: {
                        id: 2,
                        name: "Облачность",
                        control: "input_integer",
                        geomType: null,
                        library: false,
                        libraryData: {}
                    },
                    necessary: false
                },
                {
                    id: 2,
                    name: "Спутники",
                    order: 5,
                    inTable: true,
                    inTableName: "sputnik_id",
                    fieldType: {
                        id: 1,
                        name: "Список спутников",
                        control: "combobox",
                        geomType: null,
                        library: true,
                        libraryData: {
                            1: "IKONOS (1м)",
                            2: "QuickBird (0.6м)",
                            3: "EROS-A (2м)",
                            4: "EROS-B (0.7м)",
                            5: "WorldView-1 (0.5м)",
                            6: "GeoEye-1 (0.5м)"
                        }
                    },
                    necessary: false
                }
            ]
        },
        additionalFieldValues: [
            {
                field: {
                    id: 4,
                    name: "test11rrty",
                    order: 6,
                    inTable: false,
                    inTableName: null,
                    fieldType: {
                        id: 3,
                        name: "целое число",
                        control: "input_integer",
                        geomType: null,
                        library: false,
                        libraryData: {}
                    },
                    necessary: false
                },
                value: "213434априцукнр"
            }
        ],
        tableData: {
            clouds: "45",
            tecy_777: null,
            sputnik_id: "1",
            data: "2011-12-14 00:00:00+04",
            test777: "1",
            geom: null,
            layer_id: "179",
            quicklook: "kosmosnimok2012_02_08_05_06_06.jpg"
        }
    }
}





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

// является ли обязательным,булевое поле


























// массив дополнительных полей
// объект
// объект поля
// id поля,
// название, строка
// порядок отображения, целое число
// содержится ли значение в основной таблице, булевое поле
// название поля в основной таблице
// тип поля, объект
// id: типа, целое число
// название типа, строка
// управляющий элемент, который используется, строка
// тип геометрии, строка
// нужно ли искать значение поля в словаре, булевое поле
// данные словаря, объект

// является ли обязательным,булевое поле

// значение поля


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

Статус: 404 — слой не найден

Формат: text/plain

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

Статус: 403 — нет доступа к данному слою

Формат: text/plain

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

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

Формат: text/plain

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

GET /layers/{layerId}/metadata/quicklook/{file}

Отображение превью-картинки у метаданных, если она присутствует

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


GET /layers/179/metadata/quicklook/kosmosnimok2012_02_08_05_06_06.jpg?token=bw3ty3h46yth

layerId: id слоя

file: название файла, приходит в качестве значения поля превью у метаданных

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

Ответ:

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

Формат: image/jpeg и т.д.

Статус: 404 — картинка не найдена

Формат: text/plain

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

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

Формат: text/plain

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

GET /layers/{layerId}/attributes

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


GET /layers/199/attributes?token=bw3ty3h46yth

layerId: id слоя

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

Ответ:

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

Формат: json


{
    "name": "vamin_kioski_p_vwType",
    "features": [
        {
            "nillable": true,
            "name": "srnaimenovanie",
            "maxOccurs": "1",
            "type": "{http://www.w3.org/2001/XMLSchema}string",
            "minOccurs": 0
        }
    ]
}





// название слоя английское
// массив атрибутов
// объект атрибута

// название, строка

// тип

Статус: 404 — слой не найден

Формат: text/plain

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

Статус: 403 — нет доступа к данному слою

Формат: text/plain

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

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

Формат: text/plain

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

Posted in