You are here: Home / 2015 / Январь / 19 / MapSurfer — rest — orgs

MapSurfer — rest — orgs

19 января 2015 admin
назад
mapSurfer GS / Руководство разработчика REST / Организации

Доступно только для пользователей с правами администратора

GET /organizations

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


GET /organizations?token=mbs90lon2a8

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

Ответ:

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

Формат: json


[{
    "id": 1,
    "name": "Организация",
    "peopleOrg": false,
    "info": null,
    "mapExtentBBox": {
        "minX": -177.70569153577574,
        "minY": -21.944093375487366,
        "maxX": -45.8812097484691,
        "maxY": 75.49864249479484,
        "projection": "EPSG:4326"
    }
},...]




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

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

Формат: text/plain

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

Доступно только для пользователей с правами администратора

POST /organizations

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


POST /organizations?token=mbs90lon2a8

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

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

Формат: json


{
    "info": {
        "address": "Адрес компании",
        "bank": "21214244",
        "bankBik": "1012124",
        "bankKpp": "75621",
        "bankSchet": "2233253578",
        "email": "email",
        "fax": "5669988",
        "inn": "12154575212",
        "kpp": "21254575121",
        "phone": "+79655918889"
    },
    "mapExtent": ["56.72299186350165",
        "54.233424150623314",
        "54.997573909158405",
        "47.86708896501173"],
    "name": "Организация"
}




// информация об организации, объект
// адрес организации, строка
// банковские данные, строка
// банк БИК, целое число
// банк КПП, целое число
// банковский счет, целое число
// электронная почта, строка
// факс, строка
// ИНН, целое число
// КПП, целое число
// номер телефона, строка

// минимальный Х, число с плавающей точкой
// минимальный Y, число с плавающей точкой
// максимальный Х, число с плавающей точкой
// максимальный Y, число с плавающей точкой
// название организации, строка

Ответ:

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

Формат: json


{
    "id": 100,
    "name": "Компания",
    "peopleOrg": false,
    "info": {
        "address": "Адрес компании",
        "phone": "2565656",
        "fax": "",
        "email": "",
        "inn": 3223544775102,
        "kpp": null,
        "bank": "",
        "bankKpp": null,
        "bankBik": null,
        "bankSchet": ""
    },
    "mapExtentBBox": {
        "minX": 49.12158966064453,
        "minY": 55.78422354209717,
        "maxX": 49.1269326210022,
        "maxY": 55.78719766974102,
    "projection": "EPSG:4326"
    }
}




// id организации, целое число
// название организации, строка
// организация населения, булевое поле
// информация, объект
// адрес организации, строка
// номер телефона, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// банковские данные, строка
// банк БИК, целое число
// банк КПП, целое число
// банковский счет, целое число

// границы карты, объект
// минимальный Х, число с плавающей точкой
// минимальный Y, число с плавающей точкой
// максимальный Х, число с плавающей точкой
// максимальный Y, число с плавающей точкой
// проекция, строка

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

Формат: text/plain

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

Доступно только для пользователей с правами администратора

PUT /organizations/{id}

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


PUT /organizations/35?token=mbs90lon2a8

id: id организации

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

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

Формат: json


{
    "id": 35,
    "info": {
        "address": "Адрес компании",
        "bank": "",
        "bankBik": "",
        "bankKpp": "",
        "bankSchet": "",
        "email": "",
        "fax": "",
        "inn": "3223544775102",
        "kpp": "",
        "phone": "2565656"
    },
    "mapExtent":
        ["55.787197669741026",
        "55.78422354209717",
        "49.1269326210022",
        "49.12158966064453"],
    "name": "Компания",
    "peopleOrg": false
}




// id организации, целое число
// информация об организации, объект
// адрес организации, строка
// банковские данные, строка
// банк БИК, целое число
// банк КПП, целое число
// банковский счет, целое число
// электронная почта, строка
// факс, строка
// ИНН, целое число
// КПП, целое число
// номер телефона, строка
// население организации, булевое поле
// границы карты, массив
// минимальный Х, число с плавающей точкой
// минимальный Y, число с плавающей точкой
// максимальный Х, число с плавающей точкой
// максимальный Y, число с плавающей точкой
// название организации, строка
// организация населения, булевое поле

Ответ:

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

Формат: json


{
    "id": 35,
    "name": "Новое название компании",
    "peopleOrg": false,
    "info": {
        "address": "Новый адрес компании",
        "phone": "2565656",
        "fax": "",
        "email": "",
        "inn": 3223544775102,
        "kpp": null,
        "bank": "",
        "bankKpp": null,
        "bankBik": null,
        "bankSchet": ""
    },
    "mapExtentBBox": {
        "minX": 49.12158966064453,
        "minY": 55.78422354209717,
        "maxX": 49.1269326210022,
        "maxY": 55.78719766974102,
        "projection": "EPSG:4326"
    }
}




// id организации, целое число
// название организации, строка
// организация населения, булевое поле
// информация, объект
// адрес организации, строка
// номер телефона, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// банковские данные, строка
// банк БИК, целое число
// банк КПП, целое число
// банковский счет, целое число

// границы карты, объект
// минимальный Х, число с плавающей точкой
// минимальный Y, число с плавающей точкой
// максимальный Х, число с плавающей точкой
// максимальный Y, число с плавающей точкой
// проекция, строка

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

Формат: text/plain

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

Доступно только для пользователей с правами администратора

DELETE /organizations/{id}

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


DELETE /organizations/35?token=mbs90lon2a8

id: id организации

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

Ответ:

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

Формат: json


{
    "delete": true
}

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

Формат: text/plain

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

Доступно только для пользователей с правами администратора

GET /organizations.xlsx

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


GET /organizations.xlsx?token=mbs90lon2a8

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

Ответ:

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

Формат: json

Возвращает бинарный файл

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

Формат: text/plain

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

Posted in