You are here: Home / 2015 / Май / 06 / MapIssues — rest — customers

MapIssues — rest — customers

6 мая 2015 admin
назад
MapIssues GS / Руководство разработчика REST / Заказчики

GET /issues/customers

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


GET /issues/customers?token=puqw129npc074a

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

Ответ:

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

Формат: json

[{
	"id": 136,
	"name": "Имя заказчика",
	"phone": "+7 (111) 111-11-11",
	"email": "customer@custom.com",
	"comment": "",
	"addresses": [{
		"id": 181,
		"geom": {
			"type": "Point",
			"coordinates": [57.7764,
			58.1136]
		},
		"address": "Лысьва, улица Рабкоров"
	}],
	"issuesCount": 3
},…]


// id заказчика, целое число
// имя заказчика, строка
// номер телефона, строка
// электронная почта, строка
// комментарий, строка
// массив адресов
// id адреса, целое число
// информация о геометрии
// тип геометрии, строка
// координаты


// адрес, строка

// число задач, целое число

POST /issues/customers

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


POST /issues/customers?token=puqw129npc074a

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

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

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

Формат: json

{
	"name": "Новый заказчик",
	"phone": "+7 (965) 210-24-02",
	"email": "customer@gmail.com",
	"comment": "Комментарий к добавленному заказчику",
	"addresses": [{
		"address": "Москва, Варшавское шоссе, 9 с27",
		"geom": {
			"coordinates": [37.62336730957031,
			55.699259616176384],
			"type": "Point"
		}
	}]
}


// имя заказчика, строка
// номер телефона, строка
// электронная почта, строка
// комментарий, строка (необязательное поле)
// массив адресов заказчика (необязательное поле)
// адрес, строка
// информация о геометрии
// координаты

// тип геометрии, строка

Ответ:

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

Формат: json

{
	"id": 721,
	"name": "Новый заказчик",
	"phone": "+7 (965) 210-24-02",
	"email": "customer@gmail.com",
	"comment": "Комментарий к добавленному заказчику",
	"addresses": [{
		"id": 381,
		"geom": {
			"type": "Point",
			"coordinates": [37.6234,
			55.6993]
		},
		"address": "Москва, Варшавское шоссе, 9 с27"
	}],
	"issuesCount": 0
}


// id заказчика, целое число
// имя заказчика, строка
// номер телефона, строка
// электронная почта, строка
// комментарий, строка
// информация о месте
// id, целое число
// информация о геометрии
// тип геометрии, строка
// координаты


// адрес, строка

// количество заданий, целое число

GET /issues/customers/id

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


GET /issues/customers/136?token=puqw129npc074a

id: id заказчика

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

Ответ:

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

Формат: json

{
	"id": 136,
	"name": "Имя",
	"phone": "+7 (111) 111-11-11",
	"email": "",
	"comment": "",
	"addresses": [{
		"id": 181,
		"geom": {
			"type": "Point",
			"coordinates": [57.7764,
			58.1136]
		},
		"address": "Лысьва, улица Рабкоров"
	}],
	"issuesCount": 3,
	"organizationId": 7
}


// id заказчика, целое число
// имя заказчика, строка
// номер телефона, строка
// электронная почта, строка
// комментарий, строка
// массив адресов заказчика
// id, целое число
// информация о геометрии
// тип геометрии, строка
// координаты


// адрес, строка

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

PUT /issues/customers/id

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


PUT /issues/customers/27?token=puqw129npc074a

id: id заказчика

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

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

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

Формат: json

{
	"name": "Новый заказчик",
	"phone": "+7 (965) 210-24-02",
	"email": "customer@gmail.com",
	"comment": "Комментарий к добавленному заказчику",
	"addresses": [{
                "id": 342,
		"address": "Москва, Варшавское шоссе, 9 с27",
		"geom": {
			"coordinates": [37.62336730957031,
			55.699259616176384],
			"type": "Point"
		}
	}]
}


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

// тип геометрии, строка

Ответ:

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

Формат: json

{
	"id": 27,
	"name": "Новый заказчик",
	"phone": "+7 (965) 210-24-02",
	"email": "customer@gmail.com",
	"comment": "Комментарий к добавленному заказчику",
	"addresses": [{
		"id": 381,
		"geom": {
			"type": "Point",
			"coordinates": [37.6234,
			55.6993]
		},
		"address": "Москва, Варшавское шоссе, 9 с27"
	}],
	"issuesCount": 0,
        "organizationId": 736
}


// id заказчика, целое число
// имя заказчика, строка
// номер телефона, строка
// электронная почта, строка
// комментарии, строка
// информация об адресе
// id, целое число
// информация о геометрии
// тип геометрии, строка 
// координаты


// адрес, строка

// число задач, число с плавающей точкой
// id организации, целое число

DELETE /issues/customers/id

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


DELETE /issues/customers/25?token=puqw129npc074a

id: id заказчика

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

Ответ:

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

{
	"id": 25
}

Статус: 401 — необходима авторизация

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

Статус: 403 — доступ запрещен

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

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

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

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

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

Posted in