Перейти до вмісту

Редагування користувача ​

Отримання токену доступу  ​

Інструкція з отримання токену - https://medakadem.freshdesk.com/uk/support/solutions/articles/77000530947-отримання-token

Використання токену - https://medakadem.freshdesk.com/uk/support/solutions/articles/77000530917-token

Для використання API потрібні скоупи: "gambit:erp:users". Якщо немає потрібних scope, то повертатиметься помилка - Code 403 Forbidden

За допомогою даного запиту, можна редагувати дані користувача.

Потрібно в запиті вказити ідентифікатор користувача, якого потрібно редагувати, наприклад:

HTTP methods:PUT

/api/erp/v1/users/{userId}

де {userId} - унікальний ідентифікатор користувача

Request body: ​

Example Value:

{
  "ExternalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ClinicId": 0,
  "PrerecordIndex": 0,
  "DefaultInterval": 0,
  "OrderIndex": 0,
  "DefaultPageId": 0,
  "AllowRemoteLogin": true,
  "PhoneNumberConfirmed": true,
  "AllowLogin": true,
  "Born": "2025-03-10T09:24:35.268Z",
  "Experience": "2025-03-10T09:24:35.268Z",
  "MinimumCost": 0,
  "Email": "string",
  "FirstTelephone": "string",
  "SecondTelephone": "string",
  "Note": "string",
  "UserName": "string",
  "Last": "string",
  "First": "string",
  "Middle": "string",
  "Passport": "string",
  "IdentificationCode": "string",
  "AdditionalInformation": "string",
  "Education": "string",
  "ScientificDegree": "string",
  "QualificationCategory": "string",
  "UserPositionId": 0,
  "Photo": "string",
  "ExecutorId": 0,
  "IsOnline": true
}
ПараметрТипОпис
ExternalIdstring($uuid) nullable: trueунікальний ідентифікатор користувача в зовнішній системі
ClinicIdinteger($int32)ідентифікатор філіалу
PrerecordIndexinteger($int32)сортування в попередньому записі
DefaultIntervalinteger($int32)час прийому
OrderIndexinteger($int32)сортування в онлайні
DefaultPageIdinteger($int32)стартова сторінка
AllowRemoteLoginbooleanдозвіл для віддаленого входу
PhoneNumberConfirmedboolean nullable: trueпідтверджений номер телефону
AllowLoginbooleanдозвіл для входу
Bornstring($date-time) nullable: trueдата народження
Experiencestring($date-time) nullable: trueстаж
MinimumCostinteger($int32) nullable: trueмінімальна вартість прийому
Emailstring nullable: trueелектронна адреса
FirstTelephonestring nullable: trueномер телефону
SecondTelephonestring nullable: trueномер телефону
Notestring nullable: trueзамітка
UserNamestring nullable: trueлогін для входу в систему
Laststring nullable: trueпрізвище
Firststring nullable: trueім'я
Middlestring nullable: trueпо батькові
Passportstring nullable: trueпаспортні дані
IdentificationCodestring nullable: trueРНОКПП
AdditionalInformationstring nullable: trueдодаткова інформація
Educationstring nullable: trueосвіта
ScientificDegreestring nullable: trueнауковий ступінь
QualificationCategorystring nullable: trueкваліфікація
UserPositionIdinteger($int32) nullable: trueпосада
Photostring nullable: trueпосилання на фото
ExecutorIdinteger($int32) nullable: true---
IsOnlinebooleanдозвіл на онлайн

Responses: ​

При успішному виконані запиту повернеться - Code 200 Success

Example Value:

{
  0
}
0ідентифікатор відредагованого користувача

Якщо якісь вхідні дані будуть не вірного формату, то повернеться - Code 400 Bad Request

Якщо повертається Code 402 Payment Required, це означає вихід за межі тарифного плану. Дані обмеження повʼязані з вашим тарифним планом, за детальної інформацією зверніться до менеджера.