Працівники

До інформації: працівник контрагента (внутрішній користувач): може переглядати запити та документи, приймати рішення про створення сутностей та трансфер ідентифікаторів. Працівник Банку пов'язаний тільки з одним Контрагентом (Банком).

У роботі з працівниками ви маєте можливість використовувати наступні методи:

Працівники - створення працівника

Працівники - оновлення даних працівника

Працівники- отримання списку працівників до певного Контрагенту

Створення працівника

Щоб створити нового співробітника для Контрагента, слід використовувати наступний метод:

create employees and assign roles if not empty

post

create employees and assign roles if not empty

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

application/json

branch_guidstringOptional

branch's guid

emailstringOptional

employee's email

namestringOptional

employee's name

paternal_namestringOptional

employee's paternal name

phonestringOptional

employee's phone

rolesstring[]Optional

Roles if not empty assign created employee to roles from list

surnamestringOptional

employee's surname

Responses

200

OK

application/json

employee_guidstringOptional

verifiedbooleanOptional

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/employees

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/employees HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "branch_guid": "text",
  "email": "text",
  "name": "text",
  "paternal_name": "text",
  "phone": "text",
  "roles": [
    "text"
  ],
  "surname": "text"
}

{
  "employee_guid": "text",
  "verified": true
}

Приклад відповіді:

{
    "employee_guid": "d97ad667-d72c-4a93-b27d-568ca53c30c3",  //employee's guid that is used as employee's identifier
    "verified": true
}

Після створення працівника його потрібно підтвердити за допомогою верифікації електронної пошти. Замініть {bank_alias} і {email} у посиланні відповідно.

https://backoffice-bank1-integrate.dcmapis.com//reset-password/?email={email}

Очікується, що пароль встановлюється працівником за допомогою коду підтвердження, надісланого на його електронну пошту.

Ролі

До інформації: працівник має набір призначених ролей:

• роль для роботи з відповідними дозволами для певних API методів

• роль доступу до Відділення (філії)

1. Роль містить дозволи, які потрібно встановити для працівників.

   • щоб налаштувати відповідну роль під час створення працівника, необхідно заповнити параметр «ролі» в тілі запиту (як зазначено вище);

   • якщо потрібно змінити/додати/видалити роль співробітника описано в розділі:Призначити роль працівнику.

2. (Необов’язково) вам може бути цікаво використовувати філії для відокремлення працівників.

   • щоб встановити відповідну роль відділення під час створення працівника, ви повинні заповнити параметр "branch_name" в тілі запиту (як зазначено вище);

   • якщо вам потрібно змінити/додати/видалити роль співробітника, подивіться:Як додати працівника до віддлення (філії).

Оновити працівника

update employees

put

update employee

Path parameters

counterparty_guidstringRequired

Counterparty GUID

employee_guidstringRequired

Employee GUID

Body

application/json

is_disabledbooleanOptional

if you need to disable an employee you should make this parameter true, default it is false

loginstringOptional

the employee's login

namestringOptional

employee's name

paternal_namestringOptional

employee's paternal name

phonestringOptional

employee's phone

surnamestringOptional

employee's surname

Responses

200

OK

application/json

guidstringOptional

400

json with error msg

application/json

put

/counterparty/{counterparty_guid}/employees/{employee_guid}

HTTPcURLJavaScriptPython

PUT /api/v1/counterparty/{counterparty_guid}/employees/{employee_guid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "branch_guid": {
    "valid": true,
    "value": "text"
  },
  "is_disabled": true,
  "login": "text",
  "name": "text",
  "paternal_name": "text",
  "phone": "text",
  "surname": "text"
}

{
  "guid": "text"
}

Примітка: ви не можете змінити логін працівника, необхідно заповнювати в тілі запиту тільки ті параметри, які ви хочете змінити.

Приклад відповіді:

{
    "guid": "d97ad667-d72c-4a93-b27d-568ca53c30c3"  // ідентифікатор працівника, якого ви оновили
}

Список працівників контрагента

Get employees

get

Get employees

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

guidsstring[]Optional

Employee's GUIDs

loginsstring[]Optional

Employee's logins

namesstring[]Optional

Employee's names

is_disabledbooleanOptional

Include disabled

branch_guidsstring[]Optional

Employee's branch_guids

offsetintegerOptional

Offset

limitintegerOptional

Limit

orderingstring · enumOptional

Ordering

Possible values:

Responses

200

OK

application/json

branch_guidstringOptional

branch_namestringOptional

counterparty_guidstringOptional

created_atstringOptional

guidstringOptional

is_disabledbooleanOptional

loginstringOptional

namestringOptional

paternal_namestringOptional

phonestringOptional

surnamestringOptional

updated_atstringOptional

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/employees

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/employees HTTP/1.1
Accept: */*

[
  {
    "branch_guid": "text",
    "branch_name": "text",
    "counterparty_guid": "text",
    "created_at": "text",
    "guid": "text",
    "is_disabled": true,
    "login": "text",
    "name": "text",
    "paternal_name": "text",
    "phone": "text",
    "surname": "text",
    "updated_at": "text"
  }
]

У відповіді ви можете побачити працівників контрагента з їх параметрами, а також загальну кількість працівників.

Приклад відповіді

 "employees": [
        {
            "guid": "962784a1-932c-4a7c-8890-054eccbe0321",
            "counterparty_guid": "e8fd9c29-24d5-4af4-a6b9-933f59e5023d",
            "login": "[email protected]",
            "name": "NameOfEmployee2",
            "surname": "SurnameOfEmployee2",
            "paternal_name": "",
            "phone": "[phone]",
            "is_disabled": false,
            "branch_name": "TestBranch5",
            "created_at": "2023-07-14T11:18:53.641765Z",
            "updated_at": "2023-07-14T11:18:53.641765Z"
        },
        {
            "guid": "d97ad667-d72c-4a93-b27d-568ca53c30c3",
            "counterparty_guid": "e8fd9c29-24d5-4af4-a6b9-933f59e5023d",
            "login": "[email protected]",
            "name": "NameOfEmployee_2",
            "surname": "SurnameOfEmployee",
            "paternal_name": "NameOfEmployee_2",
            "phone": "",
            "is_disabled": false,
            "branch_name": "",
            "created_at": "2023-07-14T10:32:34.350283Z",
            "updated_at": "2023-07-14T10:34:50.323629Z"
        },

...
    "total": 29
}