You are here: Home / 2015 / Январь / 20 / Automap — rest — orgs(before delete /all)

Automap — rest — orgs(before delete /all)

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

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations

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


GET /organizations?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

[{
	"id": 162,
	"name": "Наименование",
	"mapExtent": "63.39152, -66.79, 94.921875, -80.15625",
	"inn": "212125458752",
	"phone": "",
	"email": "email@emailDomen.com",
	"homepage": "www.myWebSite.com",
	"kpp": "0000000000000000001",
        "address": ""
},...]

// id организации, целое число
// название организации, строка
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// ИНН, целое число
// телефон, строка
// email, строка
// домашняя страница, строка
// КПП, целое число
// адрес, строка

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

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

POST /organizations

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


POST /organizations?token=bw3ty3h46yth

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

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

Формат: json

{
	"address": "TestOrg",
	"email": "TestOrg@mail.ru",
	"homepage": "hoiee.com",
	"inn": "324234234",
	"kpp": "234234234234",
	"mapExtent": "74.7296, 27.37, 109.160156, 21.621",
	"name": "Name",
	"phone": "3223234"
}

// адрес, строка
// email, строка
// домашняя страница, строка
// ИНН, целое число
// КПП, целое число
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// название организации, строка
// телефон, строка

Ответ:

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

Формат: json

{
	"id": 240,
	"order": 100,
	"address": "TestOrg",
	"email": "TestOrg@mail.ru",
	"homepage": "hoiee.com",
	"inn": "324234234",
	"kpp": "234234234234",
	"mapExtent": "74.7296, 27.37, 109.160156, 21.621",
	"name": "TestOrg",
	"phone": "3223234"
}

// id организации, целое число
// название организации, строка
// адрес, строка
// email, строка
// домашняя страница, строка
// ИНН, целое число
// КПП, целое число
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// название организации, строка
// телефон, строка

Статус: 400 — ошибка в запросе

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

Формат: text/plain

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

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations/all

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


GET /organizations/all?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

[{
	"id": 1,
	"name": "Наименование",
	"mapExtent": "63.391, -66.79190, 94.921, -80.15625",
        "usersCount": 12,
        "groupsCount": 2,
	"inn": "357782147462",
	"phone": "",
	"email": "email@emailDomen.com",
	"homepage": "www.myWebSite.com",
	"kpp": "0000000000000000001",
	"address": "Страна, город, улица",
},...]

// id организации, целое число
// название организации, строка
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// количество пользователей, целое число
// количество групп, целое число
// ИНН, целое число
// телефон, строка
// email, строка
// домашняя страница, строка
// КПП, целое число
// адрес, строка

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

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

PUT /organizations/{id}

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


PUT /organizations/144?token=bw3ty3h46yth

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

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

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

Формат: json

{
	"id": 144,
	"address": "Адрес организации",
	"email": " ",
	"groupsCount": 4,
	"homepage": "http://www.oursite.com",
	"inn": " ",
	"kpp": " ",
	"mapExtent":"55.806,55.782,49.148,49.106",
	"name": "Новое название",
	"phone": "+79655908889",
	"usersCount": 8
}

// id организации, целое число
// адрес, строка
// email, строка
// количество групп, целое число
// домашняя страница, строка
// ИНН, целое число
// КПП, целое число
// видимая часть карты (координаты левой нижней и правой верхней точек), строка
// название организации, строка
// телефон, строка
// количество пользователей, целое число

Ответ:

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

Формат: json

{
	"id": 144,
	"name": "Новое название",
	"mapExtent":"55.806, 55.782, 49.148, 49.106",
	"address": "Адрес организации",
	"inn": "",
	"phone": "+79655908889",
	"email": "",
	"homepage": "http://www.oursite.com",
	"kpp": ""
}

// id, целое число
// название организации, строка
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// адрес, строка
// ИНН, целое число
// телефон, строка
// email, строка
// домашняя страница, строка
// КПП, целое число

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

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

DELETE /organizations/{id}

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


DELETE /organizations/32?token=bw3ty3h46yth

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

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

Ответ:

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

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

Не всевидящим пользователям доступна информация только по своей организации

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


GET /organizations/67/cars/groups?token=bw3ty3h46yth

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

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

Ответ:

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

Формат: json

[{
	"id": 4662,
	"name": "Название",
	"notes": "",
	"organizationId": 67
},...]

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

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations/count

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


GET /organizations/count?token=bw3ty3h46yth

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

Ответ:

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

Формат: text


410



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

Статус: 404 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

Posted in