Организации
Видимая область
GET /mapextents
Структура запроса:
GET /mapextents?token=puqw129npc074a
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 3,
"name": "Republic of Tatarstan",
"extent": {
"x1": 46.0927078887718,
"y1": 53.9919087034184,
"x2": 55.299713101707,
"y2": 56.6837870890742
}
},...]
Список организаций
GET /organizations
Структура запроса:
GET /organizations?token=puqw129npc074a
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"name": "ООО Организация №1",
"blocked": false,
"issuesMaxCount": 150,
"usersMaxCount":0,
"mapExtentId": 17
},...]
// id организации, целое число
// название, строка
// заблокирована, булева переменная
// максимальное количество заданий, целое число
// максимальное количество пользователей, целое число
// id видимой области, целое число
Добавление организации
POST /organizations
Структура запроса:
POST /organizations?token=puqw129npc074a
token: ключ доступа
Пример запроса:
Формат: json
{
"name": "Название организации",
"info": {
"address": "Адрес организации",
"phone": "8(495)226-16-16",
"fax": "8(495)226-16-16",
"email": "email@org.com",
"inn": 32356856787,
"kpp": 54576512,
"bank": "Сбербанк",
"bankKpp": 775001001,
"bankBik": 044525225,
"bankSchet": 45293554000
},
"mapExtent": {
"x1": 58.8080522883846,
"y1": 38.14453125,
"x2": 68.1591796875,
"y2": 53.2980555749128
}
}
// название организации, строка
// информация об организации
// адрес, строка (необязательное поле)
// номер телефона, строка (необязательное поле)
// факс, строка (необязательное поле)
// электронная почта, строка (необязательное поле)
// ИНН, целое число (необязательное поле)
// КПП, целое число (необязательное поле)
// название банка, строка (необязательное поле)
// КПП банка, целое число (необязательное поле)
// БИК банка, целое число (необязательное поле)
// счет, целое число (необязательное поле)
// видимая область
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id":55,
"name": "Название организации",
"blocked": false,
"issuesMaxCounts": 150,
"usersMaxCount": 0,
"info": {
"address": "Адрес организации",
"phone": "8(495)226-16-16",
"fax": "8(495)226-16-16",
"email": "email@org.com",
"inn": 32356856787,
"kpp": 54576512,
"bank": "Сбербанк",
"bankKpp": 775001001,
"bankBik": 044525225,
"bankSchet": 45293554000
},
"mapExtent": {
"id": 544,
"name": "ООО Организация",
"extent": {
"x1": 58.8080522883846,
"y1": 38.14453125,
"x2": 68.1591796875,
"y2": 53.2980555749128
}
}
}
// id организации, целое число
// название организации, строка
// не заблокирована ли организация, булева переменная
// максимальное число заданий, целое число
// максимальное число пользователей, целое число
// информация об организации
// адрес, строка
// номер телефона, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// название банка, строка
// КПП банка, целое число
// БИК банка, целое число
// счет, целое число
// видимая область
// id области, целое число
// название области, строка
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
Информация об организации по ID
GET /organizations/{id}
Структура запроса:
GET /organizations/1?token=puqw129npc074a
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 1,
"name": "ООО Организация №1",
"blocked": false,
"issuesMaxCounts": 150,
"usersMaxCount": 0,
"info": {
"id": 1,
"address": "Адрес организации",
"phone": "5176617",
"fax": "5176617",
"email": "org1@gmail.com",
"inn": 675424536,
"kpp": 423124578,
"bank": "ВТБ-24",
"bankKpp": 366321411,
"bankBik": 788574545778,
"bankSchet": 787542121124
},
"mapExtent": {
"id": 17,
"name": "ООО Организация №1",
"extent": {
"x1": 58.8080522883846,
"y1": 38.14453125,
"x2": 68.1591796875,
"y2": 53.2980555749128
}
}
}
// id организации, целое число
// название, строка
// заблокирована ли организация, булева переменная
// максимальное число заданий, целое число
// максимальное число пользователей, целое число
// информация об организации
// id организации, целое число
// адрес, строка
// номер телефона, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// название банка, строка
// КПП банка, целое число
// БИК банка, целое число
// банковский счет, целое число
// видимая область
// id области, целое число
// название организации, строка
// область
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
Редактирование организации
PUT /organizations/{id}
Структура запроса:
PUT /organizations/5?token=puqw129npc074a
id: id организации
token: ключ доступа
Пример запроса:
Формат: json
{
"id": 5,
"name": "ООО Организация",
"info": {
"address": "Адрес организации",
"phone": "8(495)619-19-19",
"fax": "8(495)618-18-18",
"email": "email@org.com",
"inn": 32356856787,
"kpp": 54576512,
"bank": "Сбербанк",
"bankKpp": 775001001,
"bankBik": 044525225,
"bankSchet": 45293554000
},
"mapExtent": {
"x1": 58.8080522883846,
"y1": 38.14453125,
"x2": 68.1591796875,
"y2": 53.2980555749128
}
}
// id организации, целое число
// название организации, строка
// информация об организации
// адрес, строка
// номер телефона, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// название банка, строка
// КПП банка, целое число
// БИК банка, целое число
// номер счета, целое число
// видимая область
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id":5,
"name": "ООО Организация",
"blocked": false,
"issuesMaxCounts": 150,
"usersMaxCount": 0,
"info": {
"id": 1,
"address": "Адрес организации",
"phone": "8(495)619-19-19",
"fax": "8(495)618-18-18",
"email": "email@org.com",
"inn": 32356856787,
"kpp": 54576512,
"bank": "Сбербанк",
"bankKpp": 775001001,
"bankBik": 044525225,
"bankSchet": 45293554000
},
"mapExtent": {
"id":17,
"name": "ООО Организация №1",
"extent":{
"x1": 58.8080522883846,
"y1": 38.14453125,
"x2": 68.1591796875,
"y2": 53.2980555749128
}
}
}
// id организации, целое число
// название организации, строка
// не заблокирована ли организация, булева переменная
// максимальное число заданий, булева переменная
// максимальное число пользователей, булева переменная
// информация об организации
// id организации, целое число
// адрес, строка
// номер телефона, строка
// факс, строка
// электронная почта, строка
// ИНН, целое число
// КПП, целое число
// название банка, строка
// КПП банка, целое число
// БИК банка, целое число
// номер счета, целое число
// видимая область
// id, целое число
// название организации, строка
// область
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
// координата, число с плавающей точкой
Удаление организации
DELETE /organizations/{id}
Структура запроса:
DELETE /organizations/1?token=puqw129npc074a
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 1
}
Возможные статусы ответов сервера при ошибке:
Статус: 401 — необходима авторизация
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки
Статус: 403 — доступ запрещен
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки
Статус: 404 — не найдено
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки