Archives by date

You are browsing the site archives by date.

MapIssues — rest — issues-history

4 марта 2015 admin

MapIssues GS / Руководство разработчика REST / История заданий

История заданий

GET /issues/history

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


GET /issues/history?token=puqw129npc074a

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

Возможные параметры запроса:

limit: ограничение на количество записей

offset: количество записей, которые необходимо пропустить

orderBy: порядок выводимых данных

asc: вывод записей от меньшего к большему и наоборот

issues: id заданий (через запятую)

Структура запроса с дополнительными параметрами:


GET /issues/history?limit=10&offset=5&asc=true&issues=18235,19470?token=puqw129npc074a

Ответ:

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

Формат: json

[{                                                               
        "id": 1001,                                                          
        "date": 1411137505999,                                               
        "action":"update",                                                    
        "changes": [{                                                        
                "fieldName": "text",                                         
                "oldValue": "Необходимо замерить окно",                      
                "newValue": "Необходимо замерить проём"     
        }],
        "userId": 1425,                                                      
        "issueId": 18235
},...]


// id изменения, целое число
// дата изменения, timestamp
// тип действия create|update|delete
// изменения, объект (для action=create|delete changes = null)
// название поля, строка
// старое значение, строка
// новое значение, строка

// id пользователя, целое число
// id задания, целое число

История создания заданий

GET /issues/history/create

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


GET /issues/history/create?token=puqw129npc074a

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

Возможные параметры запроса:

Как у запроса /issues/history

Ответ:

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

Формат: json

{                                                              
        "id": 1001,                                                          
        "date": 1411137505999,                                                                                               
        "changes": null,
        "userId": 1425,                                                      
        "issueId": 19468                                                     
}


// id изменения, целое число
// дата изменения, timestamp
// изменения, объект (для action=create|delete changes = null)
// id пользователя, целое число
// id задания, целое число

История обновления заданий

GET /issues/history/update

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


GET /issues/history/update?token=puqw129npc074a

id: id задания

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

Возможные параметры запроса:

Как у запроса /issues/history

Ответ:

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

Формат: json

{                                                                 
        "id": 1001,                                                          
        "date": 1411137505999,                                                                                                 
        "changes": [{                                                        
                "fieldName": "text",                                         
                "oldValue": "Необходимо замерить окно",                      
                "newValue": "Необходимо замерить проём"     
        }],
        "userId": 1425,                                                      
        "issueId": 19468                                                     
}


// id изменения, целое число
// дата изменения, timestamp
// изменения, объект (для action=create|delete changes = null)
// название поля, строка
// старое значение, строка
// новое значение, строка

// id пользователя, целое число
// id задания, целое число

История удаления заданий

GET /issues/history/delete

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


GET /issues/history/delete?token=puqw129npc074a

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

Возможные параметры запроса:

Как у запроса /issues/history

Ответ:

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

Формат: json

{                                                              
        "id": 1001,                                                          
        "date": 1411137505999,                                               
        "action":"delete",                                                    
        "changes": null,
         "userId": 1425,                                                      
        "issueId": 19468                                                     
}


// id изменения, целое число
// дата изменения, timestamp
// действие, строка
// изменения, объект (для action=create|delete changes = null)
// id пользователя, целое число
// id задания, целое число

История добавления комментариев к заданиям

GET /issues/history/comment

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


GET /issues/history/comment?token=puqw129npc074a

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

Ответ:

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

Формат: json

[{
        "id": 1,
        "date": 1423573785149,
        "changes": null,
        "issueId": 15,
        "userId": 10
},...]


// id изменения, целое число
// дата изменения, timestamp
// изменения, объект (для action=create|delete|comment changes = null)
// id задания, целое число
// id пользователя, целое число

История одного задания

GET /issues/{id}/history

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


GET /issues/15/history?token=puqw129npc074a

id: id задания

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

Ответ:

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

Формат: json

[{
        "id": 15,
        "date": 1423573785149,
        "action":"update",
        "changes": [{
                "fieldName": "customer",
                "oldValue": {
                        "type": "Point",              
                        "coordinates": [53.9648, 57.5158]
                },
                "newValue": {
                        "type": "Point",            
                        "coordinates": [53.9727, 57.5341]
                }
        }],
        "issueId": 15,
        "userId": 10
},...]


// id изменения, целое число
// дата изменения, timestamp
// тип действия create|update|delete
// список изменений (для action=create|delete|comment changes = null)
// название поля, строка
// старое значение, строка
// тип, строка
// координаты, массив

// новое значение, строка
// тип, строка
// координаты, массив


// id задания, целое число
// id пользователя, целое число

История изменения одного задания

GET /issues/{id}/history/update

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


GET /issues/15/history/update?token=puqw129npc074a

id: id задания

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

Ответ:

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

Формат: json

[{
        "id": 1964,                                    
        "date": 1418295779366,                         
        "changes": [{                                  
                "fieldName": "point.geom",             
                "oldValue": {                          
                        "type": "Point",               
                        "coordinates": [53.9648,       
                        57.5158]
                },
                "newValue": {                          
                        "type": "Point",               
                        "coordinates": [53.9727,       
                        57.5341]
                }
        }], 
        "issueId": 18235,                              
        "userId": 1425                                
},...]


// id изменения, целое число
// дата изменения, timestamp
// список изменений, (для action=create|delete changes = null)
// название поля, строка
// старое значение
// тип, строка
// координаты, массив


// новое значение, строка
// тип, строка
// координаты, массив



// id задания, целое число
// id пользователя, целое число

Возможные статусы ответов сервера при ошибке:

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

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

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

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

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

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

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

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

MapIssues — rest — issues — files

4 марта 2015 admin

MapIssues GS / Руководство разработчика REST / Файлы

Файлы

Список файлов

GET /issues/{id}/files

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


GET /issues/85/files?token=puqw129npc074a

id: id задания

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

Ответ:

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

Формат: json

[{
	"id": 24,
	"fileType": {
		"id": 1,
		"type": "photos"
	},
	"order": 1,
	"name": "gallery_20140714_163807.jpg",
	"description": "Отправлено с ru.gs.geotasks.debug",
	"geom": null
},...]


// id файла, целое число
// тип файла, массив
// id типа, целое число
// тип, строка

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

Добавление файла

POST /issues/{id}/files

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


POST /issues/35/files?token=puqw129npc074a

id: id задания

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

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

Формат: json

{
	"name": "error.png",
	"uuid": "p19dpvtgq31ig86mdeo11s9q1l6e3.png",
        "fileTypeId": 1,
	"description": "Описание",
	"geom": ""
}


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

Ответ:

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

Формат: json

{
	"id": 12,
	"fileType": {
		"id": 1,
		"type": "photos"
	},
	"order": 1,
	"name": "picture.png",
	"description": "",
	"geom": null
}


// id файла, целое число
// тип файла, объект
// id типа файла, целое число
// тип файла, строка

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

Типы файлов

GET /issues/files/types

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


GET /issues/files/types?token=puqw129npc074a

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

Ответ:

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

Формат: json


[{
	"id": 1,
	"name": "фотографии",
	"extensions": ["jpg","jpeg","png"],
	"type": "photos"
},...]



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

Просмотр файла

GET /issues/{id}/files/{fileId}

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


GET /issues/209/files/13?token=puqw129npc074a

id: id задания

fileId: id файла

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

Возможные параметры запроса:

width: ширина картинки

height: высота картинки

crop: обрезать ли картинку ровно по ширине и высоте

stretch: растягивать ли картинку по ширине и высоте

Структура запроса с дополнительными параметрами:


GET /issues/20970/files/3370?width=500&height=800&crop=false?token=puqw129npc074a

Ответ:

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

Формат: text/plain

Отдает файл/изображение

Просмотр файла по названию

GET /issues/{id}/files/{fileId}/{fileName}

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


GET /issues/209/files/13/picture.png?token=puqw129npc074a

id: id задания

fileId: id файла

fileName: название файла

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

Возможные параметры запроса:

width: ширина картинки

height: высота картинки

crop: обрезать ли картинку ровно по ширине и высоте

stretch: растягивать ли картинку по ширине и высоте

Структура запроса с дополнительными параметрами:


GET /issues/20970/files/3370/filename.png?width=500&height=800&crop=false?token=puqw129npc074a

Ответ:

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

Формат: text/plain

Отдает файл/изображение

Удаление файла

DELETE /issues/{id}/files/{fileId}

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


DELETE /issues/35/files/2?token=puqw129npc074a

id: id задания

fileId: id файла

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

Ответ:

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

Формат: json

{
	"id": 2
}

Возможные статусы ответов сервера при ошибке:

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

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

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

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

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

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

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

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

MapIssues — rest — comments

4 марта 2015 admin

MapIssues GS / Руководство разработчика REST / Комментарии к заданию

Комментарии к заданию

Список комментариев к заданию

GET /issues/{id}/comments

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


GET /issues/185/comments?token=puqw129npc074a

id: id задания

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

Ответ:

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

Формат: json

[{
        "id": 2615,
        "comment": "root-comment",
        "date": 1415375223695,
        "issueId": 185,
        "referenceId": null,
        "userInfo": {
                "id": 1425,
                "name": "Администратор №1",
                "photo": {                                 
                        "id":2,                            
                        "name": "photo.png"                    
                }
        },
        "level": 0,
        "files": [{
                "id": 5022,                                      
                "fileType": {                            
                        "id": 1,
                        "type": "photos" 
                },
                "name": "photo.jpg"    
        }],                
        "coordinates": [{
                "id": 22,
                "geom": {
                        "type": "Point",
                        "coordinates": [47.5486, 55.028]
                },
        "address": "address" 
        }]
},...]


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


// уровень вложенности комментария, целое число
// список файлов, которые прикреплены к комментарию, объект


// id файла, целое число
// тип файла

// название файла

// список координат, которые прикреплены к задаче

Добавление комментария

POST /issues/{id}/comments

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


POST /issues/35/comments?token=puqw129npc074a

id: id задания

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

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

Формат: json

{
    "comment": "Следит за ходом выполнения задания",                 
    "issueId": 35,                                                    
    "referenceId": null,                                              
    "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                                 
    }],
    "coordinates": [{                                                        
            "address": "Татарстан, Казань, улица Павлюхина, 57",
            "geom": {                                                 
                "type": "Point",                                     
                "coordinates": [49.138197898864746,                
                                55.77478084140647]
            }                                            
    }..]
}


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

// загруженные фотографии, прикрепленные к комментарию
// уникальное имя фотографии, строка
// название фотографии, строка
// описание, строка
// геометрия, geojson 

// загруженные видео, прикрепленный к комментарию
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson 

// загруженные аудио-файлы, прикрепленный к комментарию
// уникальное название файла, строка
// название файла, строка
// описание, строка
// геометрия, geojson 

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

Ответ:

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

Формат: json

{
        "id": 1814,                                         
        "comment": "Произведена фото фиксация проемов",     
        "date": 1406299212130,                              
        "issueId": 19468,                                   
        "referenceId": null,                               
        "userInfo": {                                      
                "id": 1444,                                 
                "name": "Сергеев С.В. (замерщик)",          
                "photo": {                                 
                        "id":2,                                
                        "name": "photo.png"                   
                }
        },
        "level":0,                                     
        "files": [{
                "id": 5022,                                    
                "fileType": {                                 
                        "id": 1,
                        "type": "photos" 
                },
                "name": "photo.jpg"                         
        }],
        "coordinates": [{
                "id": 22,
                "geom": {
                        "type": "Point",
                        "coordinates": [47.5486, 55.028]
                },
                "address": "address" 
        }]
}


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


// уровень вложенности комментария, целое число
// список файлов, прикрепленных к комментарию
// id файла, целое число
// тип файла



// название файла

// список координат, которые прикреплены к задаче

Удаление комментария

DELETE /issues/{id}/comments/{commentId}

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


DELETE /issues/35/comments/24?token=puqw129npc074a

commentId: id комментария

id: id задания

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

Ответ:

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

Формат: json

{
	"id": 24
}

Возможные статусы ответов сервера при ошибке:

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

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

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

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

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

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

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

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

MapIssues — rest — issues

4 марта 2015 admin

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

Задания

Список заданий

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   
},...]


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

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

// информация об исполнителе
// id исполнителя,целое число
// имя исполнителя, строка
// удален ли исполнитель, булева переменная

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

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


// увеличение карты, целое число
// адрес, строка

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

Добавление задания

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


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

Информация о задании по 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
Содержит описание ошибки

MapIssues — rest — files

4 марта 2015 admin

MapIssues GS / Руководство разработчика REST / Загрузка файлов

Загрузка файлов

POST /fileload

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


POST /fileload

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

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

Формат: json



-----------------------------1551030389197
Content-Disposition: form-data; name="name" 

p19dpo1g6m3ts192s5l083kvi27.png
-----------------------------1551030389197
Content-Disposition: form-data; name="file"; filename="Hydrangeas.jpg" 
Content-Type: image/jpeg

...файл...

Ответ:

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

Формат: json

{
	"data": ["p19dpo1g6m3ts192s5l083kvi27.png"]
}


// uuid загруженного файла, строка

Просмотр файла

GET /fileload/{uuid}

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


GET /fileload/p19dpo1g6m3ts192s5l083kvi27.png

uuid: uuid файла

Ответ:

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

Формат: text/plain

В ответ отдается файл

Просмотр изображения в рамках заданного размера

GET /fileload/{uuid}?width&height

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


GET /fileload/p19dpo1g6m3ts192s5l083kvi27.png/200/200

uuid: уникальное название

width: ширина

height: высота

Ответ:

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

Формат: text/plain

Отдает скорректированную под заданный размер картинку

Удаление файла

DELETE /fileload/{uuid}

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


DELETE /fileload/p19dpo1g6m3ts192s5l083kvi27.png?token=puqw129npc074a

uuid: uuid файла

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

Ответ:

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

Формат: json

{
	"status": "ok"
}

Возможные статусы ответов сервера при ошибке:

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

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

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

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

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

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

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

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

MapAdmin — rest — news-info

3 марта 2015 admin

mapAdmin GS / Руководство разработчика REST / Информация по сообщению

Информация по сообщению

Данные по конкретному сообщению

Формат ответа:

{
	res: 1,
	resText: "",
	news_data: {
		id: "18766",
		user_id: "1230",
		user_fio: "Пользователь1",
		department_id: "493",
		department_logo: "logo_493.png",
		department_title: "Организация1",
		news_date: "2014-11-06 14:05:00",
		title: "Тест",
		text: "Тест1",
		num_main_photo: "1",
		archive: "f",
		confirmed: "1",
		confirmed_comment: null,
		news_type_id: "1",
		system_data: "",
		restricted: "f",
		notice: "1",
		assigned_to: "493",
		assigned_department_name: "Организация2",
		assigned_to_user: "1230",
		assigned_user_fio: "Пользователь2",
		news_type_logo: "icon3d_1.png",
		news_type_icon: "icon3d_1.png",
		news_type_name: "происшествие",
		assigned_change_date: "2014-11-06 15:38:55",
		assigned_status: "3",
		category_id: "1",
		custom_fields: "{"logika":{"value":true,"field_id":41}}",
		category_name: "информационная",
		status_name: "обратная связь",
		lon: "49.1421427",
		lat: "55.7744393",
		zoom: null,
		update_date: "2014-11-07 15:36:15"
	}
}





// id сообщения
// id создателя
// ФИО создателя
// id ведомства
// логотип ведомства
// заголовок ведомства
// дата сообщения
// заголовок сообщения
// текст сообщения
// текстовое поле
// в архиве сообщение или нет (t или f)
// 0 - не просмотрена, 1 - утверждена, 2 - не утверждена
// комментарий к подтверждению
// id типа сообщения
// данные
// ограниченные или нет (t или f)
// оповещение
// кому назначено
// какому ведомству назначено
// какому пользователю назначено
// ФИО пользователя, которому назначено
// логотип типа
// иконка типа
// название типа
// дата назначения
// статус назначения
// id категории
// дополнительные поля
// название категории
// название статуса
// долгота
// широта
// увеличение
// дата обновления

Удаление сообщения

POST /news/{newsId}/

Формат входных параметров:

{
    "action": "delete" 
}

Формат ответа:

{
    "res": 1,
    "resText": "" 
}

Краткая информация по сообщению

GET /news/{newsId}/shortdata

Формат ответа:

{
    "res": 1,
    "news": {
        "id": ,
        "news_date": ,
        "date": ,
        "title": ,
        "shorttext": ,
        "department_id": ,
        "system_data": ,
        "archive": ,
        "photos": ,
        "files": ,
        "sounds": ,
        "video": ,
        "point":  
    },
    "resText": "" 
}




// id сообщения
// дата
// дата в формате дд.мм.гггг чч:мм
// заголовок
// текст
// id ведомства
// текстовое поле
// находится ли сообщение в архиве | t или f
// количество фотографий
// количество файлов
// количество звуковых файлов
// количество видео в формате flv
// 1 - есть точка, 0 - нет точки

Текст сообщения

GET /news/{newsId}/text

Формат ответа:

{
    "res": 1,
    "text": "{Текст}" 
}

Прикрепленные файлы

Путь к фотографиям сообщения: /department_files/photos

Название: photo_{department_id}_{newsId}_{num}.{ext};

Путь к видео сообщения: /department_files/video

Название: video_{department_id}_{newsId}_{num}.flv;

Путь к звуковым файлам сообщения: /department_files/sounds

Название: sounds_{department_id}_{newsId}_{num}.{ext};

Путь к файлам сообщения: /department_files/dif_files

Название: files_{department_id}_{newsId}_{num}.{ext};

Список фотографий

GET /news/{newsId}/photos

Формат ответа:

{
    "res": 1,
    "photos": [{
        "id": ,
        "num": ,
        "name": ,
        "description": ,
        "extension": ,
        "file_name": ,
        "link":  
    }],
    "resText": "" 
}




// id фотографии
// порядковый номер
// исходное название
// описание
// расширение
// название файла на сервера
// для фотографий всегда null

Удаление фотографии сообщения

POST /news/{newsId}/photos/{fileId}

fileId — id фотографии

Тело запроса:

{
    "action": "delete" 
}

Формат ответа:

{
    "res": 1,
    "resText": "" 
}

Список видео

GET /news/{newsId}/video

Формат ответа:

{
    "res": 1,
    "video": [{
        "id": ,
        "num": ,
        "description": ,
        "extension": ,
        "file_name": ,
        "link": 
    }],
    "resText": "" 
}




// id
// порядковый номер
// описание
// расширение
// название файла на сервере
// ссылка, если видео находится не на сервере

Удаление видео сообщения

POST /news/{newsId}/video/{fileId}

fileId — id видео

Тело запроса:

{
    "action": "delete" 
}

Формат ответа:

{
    "res": 1,
    "resText": "" 
}

Список файлов

GET /news/{newsId}/files

Формат ответа:

{
    "res": 1,
    "files": [{
        "id": ,
        "num": ,
        "name": ,
        "description": ,
        "extension": ,
        "file_name": ,
        "link": 
    }],
    "resText": "" 
}




// id
// порядковый номер
// исходное название
// описание
// расширение
// название файла на сервере
// для файлов всегда null

Удаление файла сообщения

POST /news/{newsId}/files/{fileId}

fileId — id файла

Тело запроса:

{
    "action": "delete" 
}

Формат ответа:

{
    "res": 1,
    "resText": "" 
}

Список звуковых файлов

GET /news/{newsId}/sounds

Формат ответа:

{
    "res": 1,
    "sounds": [{
        "id": ,
        "num": ,
        "name": ,
        "description": ,
        "extension":  ,
        "file_name": ,
        "link":  
    }],
    "resText": "",
    "sounds_converted": [ ]
}




// id
// порядковый номер
// исходное название
// описание
// расширение
// название файла на сервере
// для аудио всегда null


// массив названий сконвертированных файлов

Удаление звукового файла

POST /news/{newsId}/sounds/{fileId}

fileId — id аудио

Тело запроса:

{
    "action": "delete" 
}

Формат ответа:

{
    "res": 1,
    "resText": "" 
}

Точка сообщения

GET /news/{newsId}/point

Формат ответа:

{
    "res": 1,
    "point": ["{lon}","{lat}"],
    "resText": "" 
}

Получение pdf сообщения

GET /news/{newsId}/pdf

Изменение статуса сообщения

POST /news/{newsId}/update

Параметры:

assigned_status — статус. Цифра 1-новый, 2-назначено, 3-обратная связь, 3-выполнено

assigned_organization_id — id назначенной организации

assigned_user_id — id назначенного пользователя

category_id — id категории

news_type_id — id типа сообщения

confirmed — 1-утверждено, 2-не утверждено, 0 — новое

restricted — true/false ограниченный доступ

archive — true/false в архиве

system_data — текстовое поле

text — текст сообщения

title — заголовок сообщения

point — массив из двух элементов, координаты x и y

pointZoom — зум, на котором будет отображаться точка, можно отправить null, тогда будет взят зум по умолчанию

custom_fields — json объект, состоящий из списка дополнительных полей с их значениями

Формат:

custom_fields: "{\"translit_name1\": {\"field_id\": 12, \"value\": "Hello"}, \"translit_name2\": {\"field_id\": 14, \"value\": true}}" 

photos — массив прикрепленных фотографий, где каждый элемент — это объект с полями: file — название захваченного файла, fileName — оригинальное название файла

Формат:

"photos": [
     {"file":"naaethsde56gh.jpg","fileName":"photo1.jpg"},
     {"file":"sdbvr54456fc4.png","fileName":"photo2.png"}
   ]

videos — массив прикрепленных видео (формат, как у фотографий)

files — массив прикрепленных файлов (формат, как у фотографий)

update_comments — комментарий обновления статуса

Следующие поля не обязательные. Они необходимы только в том случае, если комментарий обновления статуса должен быть виден определенным пользователям. Каждое поле отвечает за свою группу. Отсылать только нужные поля, установить значение true.

updatecomment_visible_all — виден всем

updatecomment_visible_user — виден только автору сообщения

updatecomment_visible_assigned_to — виден админам назначенного ведомства

updatecomment_visible_assigned_to_user — виден назначенному пользователю

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

{
  "assigned_user_id": 1,
  "assigned_status": 3,
  "system_data": "обновление от 12.12.2013",
  "photos": [
          {"file":"naaethsde56gh.jpg","fileName":"photo1.jpg"},
          {"file":"sdbvr54456fc4.png","fileName":"photo2.png"}
  ],
  "update_comments": "Сообщение была назначена",
  "updatecomment_visible_user": true,
  "updatecomment_visible_assigned_to_user": true,
  "text": "Это текст сообщения",
  "point": [46.197509765625,56.480695390196296],
  "pointZoom": 14,
   "custom_fields":"{\"imia\":{\"field_id\":1,\"value\":\"неек\"},\"test4\":{\"field_id\":8,\"value\":\"значение2\"}}" 
}

Формат ответа:

{
    "res": 1,
    "resText": "" 
}