You are here: Home / 2015 / Май / 06

Archives by date

You are browsing the site archives by date.

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
Содержит описание ошибки

Нет комментариев

MapIssues — rest — places

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

GET /places

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


GET /places?token=puqw129npc074a

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

Ответ:

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

Формат: json


[{
        "id": 81,
        "name": "Место",
        "geom": {
                "type": "Point",
                "coordinates": [49.1793,
                55.7727]
        },
        "address": "Татарстан, Казань, Гвардейская улица, 53А",
        "radius": 150.0
},…]




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


// адрес, строка
// радиус, число с плавающей точкой

POST /places

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


POST /places?token=puqw129npc074a

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

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

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

Формат: json


{
        "address": "Москва, Таганская площадь, 86/1",
        "geom": {
                "type": "Point",
                "coordinates": [37.65233516693115,
                        55.741462725687825]
        },
        "name": "Новое место",
        "radius": "120"
}




// адрес, строка
// информация о геометрии
// тип геометрии, строка
// координаты


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

Ответ:

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

Формат: json


{
        "id": 262,
        "name": "Новое место",
        "geom": {
                "type": "Point",
                "coordinates": [37.6523,
                        55.7415]
        },
        "address": "Москва, Таганская площадь, 86/1",
        "radius": 120.0
}




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


// адрес, строка
// радиус, число с плавающей точкой

GET /places/id

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


GET /places/132?token=puqw129npc074a

id: id места

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

Ответ:

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

Формат: json


{
	"id": 132,
	"name": "Место",
	"geom": {
		"type": "Point",
		"coordinates": [49.1793,
		55.7727]
	},
	"address": "Татарстан, Казань, Гвардейская улица, 53А",
	"radius": 213.0
}




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


// адрес, строка
// радиус, число с плавающей точкой

GET /places/id/events

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


GET places/132/events?dateFrom=1430859600000&dateTo=1430920123215?token=puqw129npc074a

id: id места

dateFrom: дата начала

dateTo: дата конца

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

Ответ:

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

Формат: json

[{
	"userId": 86,
	"date": 1430254847000,
	"inside": false
},...]


// id пользователя, целое число
// дата события, timestamp
// находится в пределах указанного места, булева переменная

PUT /places/id

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


PUT /places/262?token=puqw129npc074a

id: id места

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

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

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

Формат: json


{
	"address": "Москва, улица Рогожский Вал, 8",
	"geom": {
		"type": "Point",
		"coordinates": [37.6747,
		55.7413]
	},
	"name": "Новое место",
	"radius": 500
}





// адрес, строка
// информация о геометрии
// тип геометрии, строка
// координаты


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

Ответ:

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

Формат: json

{
	"id": 262,
	"name": "Новое место",
	"geom": {
		"type": "Point",
		"coordinates": [37.6747,
		55.7413]
	},
	"address": "Москва, улица Рогожский Вал, 8",
	"radius": 500.0
}


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


// адрес, строка
// радиус, число с плавающей точкой

DELETE /places/id

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


DELETE /places/262?token=puqw129npc074a

id: id места

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

Ответ:

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

{
	"id": 262
}

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

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

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

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

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

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

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

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

Нет комментариев