Задания
Список заданий
GET /issues
Структура запроса:
GET /issues
Возможные параметры запроса:
Параметры позволяют отфильтровать, упорядочить или расширить запрос
view: расширенный набор полей, если view=full
limit: ограничение на количество записей
offset: количество записей, которые необходимо пропустить
orderBy: порядок выводимых данных
sortDirection: направление сортировки (asc или desc)
text: часть или полное описание задачи
statuses: id этапов работы через запятую
types: id видов работ через запятую
users: id создателей через запятую
assignedUsers: id исполнителей через запятую
customers: id заказчиков через запятую
createDateGt: фильтр по дате создания, больше чем
createDateLt: фильтр по дате создания, меньше чем
updateDateGt: фильтр по дате обновления, больше чем
updateDateLt: фильтр по дате обновление, меньше чем
assignedDateFromGt: фильтр по началу даты выполнения, больше чем
assignedDateFromLt: фильтр по началу даты выполнения, меньше чем
assignedDateToGt: фильтр по концу даты выполнения, больше чем
assignedDateToLt: фильтр по концу даты выполнения, меньше чем
idGt: все, больше чем конкретный Id
idLt: все, меньше чем конкретный Id
Структура запроса с дополнительными параметрами:
GET /issues?limit=5&offset=3&sortdirection=asc&users=15?token=puqw129npc074a
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"user": {
"id": 15,
"name": "Администратор №1",
"deleted": false
},
"createDate": 1366373700000,
"type": {
"id": 2,
"name": "Заключение договора",
"deleted": false
},
"assignedUser": {
"id": 2,
"name": "Катаев В.М. (доставщик)",
"deleted": false
},
"updateDate": 1418373577220,
"customer": {
"id": 233,
"name": "Павлов Валерий Ильич",
"deleted": false
},
"customerPhone": "12",
"assignedDateFrom": 1402099320000,
"assignedDateTo": 1402171200000,
"point": {
"id": 1,
"geom": {
"type": "Point",
"coordinates": [53.9727,
57.5341]
},
"zoom": 12,
"address": "Удмуртская республика"
},
"organizationId": 2,
"priorityId": 3,
"statusId": 2,
"assignedOrganizationId": 7
},...]
Добавление задания
POST /issues
Структура запроса:
POST /issues?token=puqw129npc074a
token: ключ доступа
Пример запроса:
Формат: json
{
"assignedDateFrom": 1420092000000,
"assignedDateTo": 1420135200000,
"assignedUserId": 1450,
"customFields": {
"pole1": {
"field_id": 1,
"value": "123241"
},
"pole2": {
"field_id": 2,
"value": "test test test"
}
},
"priority": 1,
"customerId": 231,
"customer": "Петренко И.Р.",
"customerPhone": "+7-(965)-564-46-65",
"files": [{
"uuid": "p19duu3hoe1it5n1v1r878e0iun9.docx",
"name": "file.docx",
"description": "",
"geom": null
}],
"photos": [{
"uuid": "p19duu2s9f1ktr16cp933qam58s5.png",
"name": "photo.png",
"description": "",
"geom": null
}],
"videos": [{
"uuid": "p19duu3hoe1it5n1v1r878e0iun9.flv",
"name": "video.flv",
"description": "",
"geom": null
}],
"sounds": [{
"uuid": "p19duu3hoe1it5n1v1r878e0iun9.mp3",
"name": "audio.mp3",
"description": "",
"geom": null
}],
"point": {
"address": "Татарстан, Казань, улица Павлюхина, 57"
"geom": {
"type": "Point",
"coordinates": [49.138197898864746,
55.77478084140647]
}
},
"text": "Доставка",
"typeId": 3
}
// время начала выполнения задания, timestamp
// время окончания выполнения задания, timestamp
// id назначенного исполнителя, целое число
// дополнительные поля
// translit дополнительного поля
// id дополнительного поля
// значение дополнительного поля
// id приоритета задачи
// id заказчика, целое число (если customerId не передан, используется для создания нового заказчика)
// имя заказчика, строка
// номер заказчика, строка
// загруженные файлы
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson
// загруженные фотографии
// уникальное имя фотографии, строка
// название фотографии, строка
// описание, строка
// геометрия, geojson
// загруженные видео
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson
// загруженные аудио-файлы
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson
// местоположение
// адрес, строка
// информация о точке местоположения
// тип геометрии, строка
// координаты, массив
// описание задания, строка
// id вида работ, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 20970,
"user": {
"id": 1425,
"name": "Администратор №1",
"deleted": false
},
"createDate": 1423821668759,
"type": {
"id": 3,
"name": "Доставка",
"deleted": false
},
"assignedUser": {
"id": 1450,
"name": "Катаев В.М. (доставщик)",
"deleted": false
},
"updateDate": null,
"customer": {
"id":32,
"name":"Иванов В.О.",
"deleted": false
},
"customerPhone": "+7-(968)-814-14-82",
"assignedDateFrom": 1423893600000,
"assignedDateTo": 1423895400000,
"point": {
"id": 20970,
"geom": {
"type": "Point",
"coordinates": [49.23,
55.7476]
},
"zoom": 12,
"address": "Татарстан, Казань, улица Сафиуллина, 17"
},
"organizationId": 736,
"priorityId": 1,
"statusId": 1,
"text": "Доставить подарок",
"customFields": {
"pole1": {
"field_id": 1,
"value": "34523453"
},
"pole2": {
"field_id": 2,
"value": "rwthwrhwrt"
},
},
"assignedOrganizationId": 736
}
// id задания, целое число
// информация о создателе, объект
// id текущего пользователя, целое число
// имя пользователя, строка
// удален ли пользователь, булева переменная
// дата добавления задания, timestamp
// вид работы, объект
// id вида работ, целое число
// название, строка
// удален ли вид работы, булева переменная
// данные об исполнителе
// id исполнителя,целое число
// имя исполнителя, строка
// удален ли исполнитель, булева переменная
// дата обновления, timestamp
// информация о заказчике
// id заказчика, целое число
// имя заказчика, строка
// удален ли заказчик, булева переменная
// телефон заказчика, строка
// срок выполнения от, timestamp
// срок выполнения до, timestamp
// метка на карте, объект
// id задания, целое число
// геометрия точки, объект
// тип геометрии, строка
// координаты, число с плавающей точкой
// уровень отображения на карте, целое число
// адрес, строка
// id организации, целое число
// id приоритета, целое число
// id этапа работ, целое число
// описание задания, строка
// дополнительные поля, объект
// id назначенной организации, целое число
Количество заданий
GET /issues/count
Структура запроса:
GET /issues/count?token=puqw129npc074a
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
47
// количество заданий, целое число
Информация о задании по ID
GET /issues/{id}
Структура запроса:
GET /issues/35?token=puqw129npc074a
id: id задания
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 35,
"user": {
"id": 86,
"name": "Волкова Юлия",
"deleted": false
},
"createDate": 1421071657583,
"type": {
"id": 2,
"name": "Заключение договора",
"deleted": false
},
"assignedUser": {
"id": 28,
"name": "Иваненко П.А.",
"deleted": false
},
"updateDate": 1421071970906,
"customer": {
"id": 981,
"name": "Зыкина Светлана Петровна",
"deleted": false
},
"customerPhone": "518-96-96",
"assignedDateFrom": 1421157960000,
"assignedDateTo": 1421161560000,
"point": {
"id": 35,
"geom": {
"type": "Point",
"coordinates": [49.1682,
55.7649]
},
"zoom": 12,
"address": "Казань, улица Даурская, дом 30"
},
"organizationId": 6,
"priorityId": 1,
"statusId": 1,
"text": "Заключить договор. Без опозданий.",
"customFields": {
"pole1": {
"field_id": 1,
"value": "5345345"
}
},
"assignedOrganizationId": 6
}
// id задания, целое число
// информация о создателе
// id пользователя, целое число
// имя пользователя, строка
// удален ли пользователь, булева переменная
// дата создания, timestamp
// вид работ, объект
// id вида работы, целое число
// название вида работ, строка
// удален ли вид работы, булева переменная
// данные исполнителя, объект
// id исполнителя,целое число
// имя исполнителя, строка
// удален ли исполнитель, булева переменная
// дата обновления, timestamp
// заказчик, объект
// id заказчика, целое число
// имя заказчика, строка
// удален ли заказчик, булева переменная
// телефон заказчика, строка
// срок выполнения, timestamp
// срок выполнения, timestamp
// местоположение, объект
// id задания, целое число
// геометрия точек, объект
// тип геометрии, строка
// координаты типа геометрии
// увеличение карты, целое число
// адрес заказчика, строка
// id организации, целое число
// id приоритета, целое число
// id этапа работы, целое число
// описание, строка
// дополнительные поля
// translit дополнительного поля
// id дополнительного поля
// значение дополнительного поля
// id назначенной организации, целое число
Редактирование задания
PUT /issues/{id}
Структура запроса:
PUT /issues/35?token=puqw129npc074a
id: id задания
token: ключ доступа
Пример запроса:
Формат: json
{
"id": 20970,
"assignedDateFrom": 1423893600000,
"assignedDateTo": 1423895400000,
"assignedUserId": 1450,
"customerId": 981,
"customerName": "",
"customerPhone": "+7-(968)-814-14-82",
"typeId": 1,
"priorityId": 1,
"statusId": 1,
"text": "Доставка в строго указанное время",
"point": {
"address": "Татарстан, Казань, проспект Победы, 30",
"geom": {
"type": "Point",
"coordinates": [49.19780731201172,
55.74238072848889]
},
},
"files": [
{
"uuid": "p19dv32ej595n1hoem492ea1l1p9.xlsx",
"name": "valid.xlsx",
"description": "",
"geom": null
},
{
"id": 3368,
"name": "Автомап - админка.docx",
"description": "",
"geom": null
}
],
"photos": [{
"uuid": "p19e16u9b689f1jmnk8n16u3tuvd.png",
"name": "error.png",
"description": "",
"geom": null
}],
"videos": null,
"sounds": null
}
// id задания, целое число
// время начала выполнения задания, timestamp
// время окончания выполнения задания, timestamp
// id пользователя, целое число
// id заказчика, целое число
// имя заказчика (используется только в случае, если cistomerId не передан и нужно указать нового заказчика)
// телефон заказчика, строка
// id вида работ, целое число
// id приоритета, целое число
// id этапа работы, целое число
// описание задания, строка
// местоположение, null - если нет необходимости менять информацию
// адрес задания, строка
// информация о геометрии
// тип геометрии, строка
// координаты, массив
// информация о прикрепленных файлах
// загрузка нового файла
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson
// информация о старом файле
// id файла, целое число
// название, строка
// описание, строка
// геометрия, geojson
// информация о новой фотографии
// уникальное название фотографии, строка
// название фотографии, строка
// описание, строка
// геометрия, geojson
// информация о прикрепленных видео-файлах
// информация о прикрепленных аудио-файлах
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 20933,
"user": {
"id": 1425,
"name": "Администратор №1",
"deleted": false
},
"createDate": 1423573896979,
"type": {
"id": 2,
"name": "Заключение договора",
"deleted": false
},
"assignedUser": {
"id": 1450,
"name": "Катаев В.М. (доставщик)",
"deleted": false
},
"updateDate": null,
"customer": {
"id":32,
"name":"Иванов В.О.",
"deleted": false
},
"customerPhone": "+79655888545",
"assignedDateFrom": 1423574100000,
"assignedDateTo": 1423580400000,
"point": {
"id": 20933,
"geom": {
"type": "Point",
"coordinates": [49.1261,
55.7867]
},
"zoom": 12,
"address": "Татарстан, Казань, улица Бутлерова, 4"
},
"organizationId": 736,
"priorityId": 1,
"statusId": 1,
"text": "Заключить договор с 4 до 6 вечера",
"customFields": {
"pole1": {
"field_id": 1,
"value": "34523453"
},
"pole2": {
"field_id": 2,
"value": "rwthwrhwrt"
},
},
"assignedOrganizationId": 736
}
// id задания, целое число
// информация о создателе
// id текущего пользователя, целое число
// имя пользователя, строка
// удален ли пользователь, булева переменная
// дата добавления задания, timestamp
// вид работ, объект
// id вида работ, целое число
// название, строка
// удален ли вид работ, булева переменная
// информация об исполнителе
// id пользователя,целое число
// имя пользователя, строка
// удален ли исполнитель, булева переменная
// дата обновления, timestamp
// информация о заказчике
// id заказчика, целое число
// имя заказчика, строка
// удален ли заказчик, булева переменная
// телефон заказчика, строка
// время начала исполнения, timestamp
// время окончания исполнения, timestamp
// метка на карте
// id задания, целое число
// геометрия точки
// тип геометрии, строка
// координаты, число с плавающей точкой
// уровень отображения на карте, целое число
// адрес, строка
// id организации, целое число
// id приоритета, целое число
// id этапа работ, целое число
// описание задания, строка
// дополнительные поля
// id назначенной организации, целое число
Частичное редактирование задания
PATCH /issues/{id}
Структура запроса:
PATCH /issues/35?token=puqw129npc074a
id: id задания
token: ключ доступа
Пример запроса:
Формат: json
{
"typeId": 1,
"statusId": 1,
"text": "Доставка в строго указанное время",
"priorityId": 1,
"assignedUserId": 4964,
"customerId": 981,
"customerName": "",
"customerPhone": "+7-(965)-564-46-65",
"assignedDateFrom": 1423807200000,
"assignedDateTo": 1423808700000,
"point": {
"address": "Татарстан, Казань, улица Карбышева, 58А",
"geom": {
"type": "Point",
"coordinates": [49.17755126953125,
55.754940702479146]
},
},
"customFields": {
"pole1": {
"field_id": 1,
"value": "123241"
},
"pole2": {
"field_id": 2,
"value": "test test test"
}
},
"point": {
"address": "Татарстан, Казань, улица Карбышева, 58А",
"geom": {
"type": "Point",
"coordinates": [49.17755126953125,
55.754940702479146]
},
},
"files": [{
"uuid": "p19dv32ej595n1hoem492ea1l1p9.xlsx",
"name": "valid.xlsx",
"description": "",
"geom": null
},
{
"id": 3523,
"name": "СЧЕТ.pdf",
"description": "",
"geom": null
}
],
"photos": [{
"uuid": "p19dv32kfr1mrv1s3o1qgbhco1hupb.png",
"name": "screen.png",
"description": "",
"geom": null
}
],
"videos": null,
"sounds": null
}
// id вида работ, целое число
// id этапа работы, целое число
// описание задания, строка
// id приоритета, целое число
// id исполнителя, целое число
// id заказчика, целое число
// имя заказчика (используется только в случае, если customerId не передан и нужно создать нового заказчика), строка
// телефон заказчика, строка
// время начала выполнения задания, timestamp
// время окончания выполнения задания, timestamp
// местоположение, null - если нет необходимости менять информация, иначе новые данные
// адрес задания, строка
// информация о геометрии
// тип геометрии, строка
// координаты, массив
// дополнительные поля
// translit дополнительного поля
// id дополнительного поля
// значение дополнительного поля
// местоположение, null - если нет необходимости менять информация, иначе новые данные
// адрес задания, строка
// информация о геометрии
// тип геометрии, строка
// координаты, массив
// информация о прикрепленных файлах
// загрузка нового файла
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson
// информация о старом файле
// загрузка новой фотографии
// уникальное название фотографии, строка
// название фотографии, строка
// описание, строка
// геометрия, geojson
// информация о прикрепленных видео-файлах
// информация о прикрепленных аудио-файлах
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 20969,
"user": {
"id": 1425,
"name": "Администратор №1",
"deleted": false
},
"createDate": 1423746136128,
"type": {
"id": 3,
"name": "Доставка",
"deleted": false
},
"assignedUser": {
"id": 1450,
"name": "Катаев В.М. (доставщик)",
"deleted": false
},
"updateDate": null,
"customer":{
"id":32,
"name":"Иванов В.О.",
"deleted": false
},
"customerPhone": "+7-(965)-564-46-65",
"assignedDateFrom": 1420092000000,
"assignedDateTo": 1420135200000,
"point": {
"id": 2096,
"geom": {
"type": "Point",
"coordinates": [49.1382,
55.7748]
},
"zoom": 12,
"address": "Казань, улица Павлюхина, 57"
},
"organizationId": 736,
"priorityId": 1,
"statusId": 1,
"text": "Доставка",
"customFields": {
"pole1": {
"field_id": 1,
"value": "34523453"
},
"pole2": {
"field_id": 2,
"value": "rwthwrhwrt"
},
},
"assignedOrganizationId": 736
}
// id задания, целое число
// данные о создателе, объект
// id текущего пользователя, целое число
// имя пользователя, строка
// удален ли пользователь, булева переменная
// дата добавления задания, timestamp
// вид работ, объект
// id вида работ, целое число
// название, строка
// удален ли вид работ, булева переменная
// данные об исполнителе, объект
// id исполнителя, целое число
// имя исполнителя, строка
// удален ли исполнитель, булева переменная
// дата обновления, timestamp
// информация о заказчике
// id заказчика, целое число
// имя заказчика, строка
// удален ли заказчик, булева переменная
// телефон заказчика, строка
// срок выполнения от, timestamp
// срок выполнения до, timestamp
// метка на карте, объект
// id задания, целое число
// геометрия точки, объект
// тип геометрии, строка
// координаты, число с плавающей точкой
// уровень отображения на карте, целое число
// адрес, строка
// id организации, целое число
// id приоритета, целое число
// id этапа работ, целое число
// описание задания, строка
// дополнительные поля, объект
// id назначенной организации, целое число
Удаление задания
DELETE /issues/{id}
Структура запроса:
DELETE /issues/35?token=puqw129npc074a
id: id задания
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 35
}
Возможные статусы ответов сервера при ошибке:
Статус: 401 — необходима авторизация
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки
Статус: 403 — доступ запрещен
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки
Статус: 404 — не найдено
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Содержит описание ошибки