Редагування прив’язки між маршрутом та користувачем

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/route/users

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

routeId, isOwner, userId

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту методу API

Параметр

Mandatory/Optional

Формат

Опис

routeId

M

long

id маршруту

users

M

ArrayList<User>

масив об’єктів; дані користувачів

Об’єкт User

Mandatory/Optional

Формат

Опис

userId

M

long

id користувача

isOwner

M

long

ознака власника аккаунту; 0 - ні, 1 - так

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageRoute)

Таблиця 2 - Опис параметрів об’єкта PackageRoute

Параметр

Формат

Опис

Об’єкт PackageRoute

routeId

long

id маршруту

companyId

long

id компанії

name

String

найменування маршруту

code

String

код маршруту

status

int

статус маршруту; 1 - активний; 2 - заблокований

company

Company_

об’єкт; дані компанії

users

List<User>

масив об’єктів; користувачі

contracts

List<Contract_>

масив об’єктів; сценарії документообігу

packageTypes

List<PackageType_>

масив об’єктів; налаштування комплектів документів

isAllContracts

boolean

відмітка про всі сценарії документообігу; 0 - ні; 1 - так

isAllPackageTypes

boolean

відмітка про всі типи комплектів документів; 0 - ні; 1 - так

direction

int

напрямок маршруту; 1 - від клієнта до власника; 2 - від власника до клієнта

Таблиця 3 - Опис параметрів об’єкта User

Параметр

Формат

Опис

Об’єкт User

userId

long

ID користувача

accountId

long

ID аккаунта

email

String

email та логін користувача

password

String

пароль користувача

isOwner

int

ознака власника аккаунта; 0 - ні, 1 - так

isCaptcha

Integer

ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)

fio

String

ПІБ користувача

tel

String

телефон

companies

List<Company_>

масив об’єктів; компанії

account

Account_

об’єкт; дані облікового запису

status

int

статус користувача («1» - активний; «2» - заблокований)

roles

List<Role_>

масив об’єктів; ролі

routes

List<PackageRoute>

масив об’єктів; маршрути

passSecureType

int

рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)

passPolicyId

long

id пральний політики, застосованої до користувача

userInfo

UserInfo_

об’єкт; інформація про користувача

lastLoginIp

String

IP-адреса останнього входу

lastLoginDate

long

дата останнього входу

uiTypes

List<UIType2Role_>

масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей


Приклади

Приклад тіла запиту (json):

приклад відсутній

Приклад тіла відповіді (json):

{
  "routeId": 251,
  "companyId": 4,
  "name": "vvvv",
  "code": "3ea391f8309246d4b8a6447f406abebf",
  "status": 2,
  "users": [
    {
      "userId": 473,
      "accountId": 8,
      "email": "test@test33232",
      "isOwner": 0,
      "isCaptcha": 1,
      "fio": "test test ",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 282,
      "lastLoginIp": "0.0.0.0",
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    },
    {
      "userId": 487,
      "accountId": 8,
      "email": "fdsfdsfds@dfsfs.ua",
      "isOwner": 0,
      "isCaptcha": 1,
      "fio": "fdsfds",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 282,
      "lastLoginIp": "0.0.0.0",
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    }
  ],
  "contracts": [],
  "packageTypes": [],
  "isAllContracts": false,
  "isAllPackageTypes": false,
  "direction": 1
}