mapSurfer -rest — objects

mapSurfer GS / Руководство разработчика REST / Получение объектов

Получение объектов

Список объектов в точке

POST /layers/feature

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


GET /layers/feature?token=bw3ty3h46yth

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

Пример запроса:


{
    "layersId": ["198","245","345"],
    "size": {
        "x": 1920,
        "y": 778
    },
    "extent": {
        "_southWest": {
            "lat": 55.488191455802244,
            "lng": 47.94158935546874
        },
        "_northEast": {
            "lat": 56.08889483995169,
            "lng": 50.57830810546875
        }
    },
    "point": {
        "x": 859,
        "y": 364
    }
}



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

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

// координаты верхней правой точки на карте в градусах, объект
// широта верхней правой точки, число с плавающей точкой
// долгота верхней правой точки, число с плавающей точкой


// точка, в которой происходит поиск. в пикселях, объект
// координата х, целое число
// координата y, целое число


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

Формат: json



{
    "data": {
        "kziokzn:vamin_kioski_p_vw": {
            "features": [
                {
                    "fid": "141",
                    "zayavit": "ОАО \"Вамин Татарстан\"",
                    "syyinfo":"Есть",
                    "srnaimenovanie":"Ново-савиновский",
                    "geom":"",
                    "nomerdoma":"47","
                    sunaimenovanie":"10летОктября[П, Ст.Победилово]",
                    "syinfo":"Есть",
                    "svinfo":"Существующий"
                }
            ],
            "layerId":198,
            "geomFieldName":null
        }
    }
}






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









// id слоя
// поле геометрии либо null




Статус: 403 - нет доступа к слоям

Формат: text/plain
Содержит описание ошибки

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

Формат: text/plain
Содержит описание ошибки

Список объектов в области
POST /layers/feature/bbox
Структура запроса:



GET /layers/feature/bbox?token=bw3ty3h46yth



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

Пример запроса:




{
    "layersId": ["198","234","23"],
    "srs": "EPSG:4326",
    "extent": {
        "_southWest": {
            "lng": 49.04296875,
            "lat": 55.754940702479146
        },
        "_northEast": {
            "lng": 49.299774169921875,
            "lat": 55.90457539720638
        }
    }
}






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

// координаты верхней правой точки области, объект
// широта верхней правой точки, число с плавающей точкой
// долгота верхней правой точки, число с плавающей точкой




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

Формат: json



{
    "data": {
        "kziokzn:vamin_kioski_p_vw": {
            "features": [
                {
                    "fid": "141",
                    "zayavit": "ОАО \"Вамин Татарстан\"",
                    "syyinfo":"Есть",
                    "srnaimenovanie":"Ново-савиновский",
                    "geom":"",
                    "nomerdoma":"47","
                    sunaimenovanie":"10летОктября[П, Ст.Победилово]",
                    "syinfo":"Есть",
                    "svinfo":"Существующий"
                }
            ],
            "layerId":198,
            "geomFieldName":null
        }
    }
}






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









// id слоя
// поле геометрии либо null




Статус: 403 - нет доступа к слоям

Формат: text/plain
Содержит описание ошибки

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

Формат: text/plain
Содержит описание ошибки

Получение медиа информации, прикрепленной к объекту слоя
GET layers/eis/{layerId}/{objectId} 
Структура запроса:



GET /layers/eis/198/141?token=bw3ty3h46yth



layerId: id слоя
objectId: значение первичного ключа объекта
token: ключ доступа

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

Формат: json



{
    "files": [
        {
            "url": "/layers/eis/198/141/photo/247",
            "fileName": "Чистопольская,47.JPG",
            "type": {
                "id": 3,
                "name": "photo"
            },
            "asUrl": false
        },
        {
            "url": "/layers/eis/198/141/file/247",
            "fileName": "Чистопольская,47.JPG",
            "type": {
                "id": 4,
                "name": "file"
            },
            "asUrl": false
        }
    ]
}






// массив найденных прикрепленных файлов
// прикрепленный файл, объект
// путь к файлу
// название файла
// тип файла
// id типа,
// название типа, может быть photo, video, audio, file

// представлен ли файл как ссылка




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

Формат: text/plain
Содержит описание ошибки

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

Формат: text/plain
Содержит описание ошибки

Получение медиа файла, прикрепленного к объекту слоя
GET layers/eis/{layerId}/{objectId}/photo/{photoId}
Отображение прикрепленной фотографии
Структура запроса:



GET /layers/eis/198/141/photo/247?token=bw3ty3h46yth



layerId: id слоя
objectId: первичный ключ объекта
photoId: первичный ключ фотографии
token: ключ доступа

GET layers/eis/{layerId}/{objectId}/photo/{photoId}/{height}
Отображение прикрепленной фотографии с масштабированием по высоте
Структура запроса:



GET /layers/eis/198/141/photo/247/100?token=bw3ty3h46yth



layerId: id слоя
objectId: первичный ключ объекта
photoId: первичный ключ фотографии
height: высота для масштабирования
token: ключ доступа

GET layers/eis/{layerId}/{objectId}/photo/{photoId}/{height}/{width}
Отображение прикрепленной фотографии с масштабированием по высоте  и ширине
Структура запроса:



GET /layers/eis/198/141/photo/247/100/150?token=bw3ty3h46yth



layerId: id слоя
objectId: первичный ключ объекта
photoId: первичный ключ фотографии
height: высота для масштабирования
width: ширина для масштабирования
token: ключ доступа

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

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

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

Формат: text/plain
Содержит описание ошибки

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

Формат: text/plain
Содержит описание ошибки

GET /layers/eis/{layerId}/{objectId}/{fileType}/{fileId} 
Отображение прикрепленного файла
Структура запроса:



GET /layers/eis/198/141/file/247?token=bw3ty3h46yth



layerId: id слоя
objectId: первичный ключ объекта
fileType: тип файла: photo, video, audio, file
fileId: первичный ключ файла
token: ключ доступа

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

Формат: зависит от типа отдаваемого файла

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

Формат: text/plain
Содержит описание ошибки

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

Формат: text/plain
Содержит описание ошибки