You are here: Home / 2013 / Ноябрь / 19 / Automap — rest — orgs

Automap — rest — orgs

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

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

GET /organizations

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


GET /organizations?token=bw3ty3h46yth

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

Параметры фильтрации


GET /organizations?name=org name

name: поиск организаций по названию

Ответ:

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

Формат: json


[
	{
		id: 1162,
		name: "name",
		mapExtent: "63.39152, -66.79, 94.921875, -80.15625",
		order: 100,
		address: "город и улица",
		inn: "00000000001",
		phone: "",
		email: "email@emailDomen.com",
		homepage: "www.myWebSite.com",
		kpp: "0000000000000000001"
	}
]



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

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

PUT /organizations/{id}

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


PUT /organizations/{id}?token=bw3ty3h46yth

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

{id}: id контрольной точки

Формат: json


{
	id: 1422,
	address: "TestOrg",
	email: "TestOrg@mail.ru",
	homepage: "TestOrg.ru",
	inn: "12333322333",
	kpp: "12222222222",
	mapExtent: "75.715633, 30.7512, 142.91, 55.3710",
	name: "TestOrg",
	phone: "89647333642",
	order: 100
}




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

Ответ:

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

Формат: json


{
	id: 1422,
	address: "TestOrg",
	email: "TestOrg@mail.ru",
	homepage: "TestOrg.ru",
	inn: "12333322333",
	kpp: "12222222222",
	mapExtent: "75.715633, 30.7512, 142.91, 55.3710",
	name: "TestOrg",
	phone: "89647333642",
	order: 100
}




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

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

Статус: 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: "refrfe"
	phone: "3223234"
}




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

Ответ:

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

Формат: json


{
	id: 1422
	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

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

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

DELETE /organizations/{id}

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


DELETE         /organizations/{id}?token=bw3ty3h46yth

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

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

POST /organizations/change

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


POST   /organizations/change?token=bw3ty3h46yth

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

Формат: json


{
	id: "123"
}




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

Ответ:

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

Формат: json


{
	status: 1
}




// статус выполнение

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

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

Формат: text/plain

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

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

GET /organizations/count

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


GET     /organizations/count?token=bw3ty3h46yth

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

Ответ:

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

Формат: text


10



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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

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


GET /organizations/{id}/cars/groups?token=bw3ty3h46yth

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

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

Ответ:

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

Формат: json


[
	{
		id: 4662,
		name: "234",
		notes: "",
		extGroup: null,
		view: true,
		organizationId: 1143
	}	
]



// массив объектов групп

// id группы
// название группы
// описание

// видима ли
// id организации

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

Формат: text/plain

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

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

Формат: text/plain

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

Posted in