docs on База знаний DataMobile

docs (DELETE)

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

DELETE

Назначение

Удаление документа

Где используется

АРМ.Диспетчера / Документы - для выделенного документа по кнопке “Удалить заказ” или “Удалить возврат” или “Удалить поручение”

Запрос


http://dmd.data-mobile.ru/api/erp/docs/<id> 

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Параметры

Наименование	Тип	Описание
id (обязательно)	string	Идентификатор документа
force	boolean	Принудительное удаление документа

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


http://dmd.data-mobile.ru/api/erp/docs/107f02aa-ae2f-11ef-92f2-6245b4e7a4ef?force=true 

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Ответ

Возвращается статус код 200

docs (GET)

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Получение выбранного документа с сервера

Где используется

АРМ.Диспетчера / Документы - выбор строки документа нажатием или внесение документа в базу

Запрос

Параметры запроса

Наименование	Тип	Описание
page	string	Номер порции массива объектов документов
per_page	string	Значение максимального количества объектов документов в порции

Тело запроса

Наименование	Тип	Описание
ids	string	Идентификатор выбранного документа

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


http://dmd.data-mobile.ru/api/erp/docs?page=1&per_page=10

Content-Type: application/json 
Authorization: Bearer <TOKEN>


{
 "ids" : [ "0d5c185d-7cc8-11f0-9fa7-8a884b81b7da" ]
}

Ответ

Тело ответа

Наименование	Тип	Описание
data	object array	Массив объектов документов в порции
page	object	Объект информации о порции документов

Пример ответа #1

Получение завершенного оплаченного документа с КМ

docs (PUT)

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Порционная выгрузка массива документов - до 10 документов в одном запросе - из учетной системы на сервер

Где используется

АРМ.Диспетчера / Документы - Заказы/Возвраты/Поручения - “Добавить”

Запрос


http://dmd.data-mobile.ru/api/erp/docs 

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Тело

Наименование	Тип	Описание
data	object array	Массив объектов документов (до 10 документов включительно в одном запросе)

Пример тела запроса

Выгрузка документа с маркируемыми позициями (по одной из строк выгрузка сразу с КМ)

docs/headers (GET)

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

GET

Назначение

Порционное получение массива объектов документов без деталей с сервера

Где используется

АРМ.Диспетчера / Документы - кнопка Обновить

Запрос

Параметры запроса

Наименование	Тип	Описание
page	string	Номер порции массива объектов документов
per_page	string	Значение максимального количества объектов документов в порции

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


http://dmd.data-mobile.ru/api/erp/docs/headers?page=1&per_page=10

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Ответ

Тело

Наименование	Тип	Описание
page	object	Объект информации о порции документов
data	object array	Массив объектов документов в порции

Пример ответа #1

Порционное получение массива объектов шапок документов с сервера

docs/#id#/user/change (PUT)

Mon, 01 Jan 0001 00:00:00 +0000

Тип метода

PUT

Назначение

Переназначение пользователя документа

Где используется

АРМ.Диспетчера / Документы - для выделенного документа по кнопке Сменить курьера

Пример запроса #1

Сброс пользователя для документа


http://dmd.data-mobile.ru/api/erp/docs/<id>/user/change", 

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Пример запроса #2

Переназначение пользователя для документа


http://dmd.data-mobile.ru/api/erp/docs/<id>/user/change?user_id=<user_id>", 

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Параметры

Наименование	Тип	Описание
id (обязательно)	string	Идентификатор документа
user_id	string	Идентификатор пользователя

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


http://dmd.data-mobile.ru/api/erp/docs/3bcea661-8270-11f0-9fab-8a884b81b7da/user/change?user_id=5c741bac-084a-11dc-a417-00055d80a2d1",

Content-Type: application/json 
Authorization: Bearer <TOKEN>

Ответ

Возвращается статус код 200