Обновление реквизитов клиента

Последние изменения: 28.02.2023

Для вызова метода API Sherlock Platform необходимо авторизоваться. Полученный токен надо передать в заголовке как Bearer Token.

Для обновления реквизитов клиента предназначен метод PATCH контроллера Client (шаблон URL вызова метода https://<SherlockPlatform_API>/v2/Client/<client_id>)

В качестве параметра метода необходимо передать текст в формате json следующей структуры:

[
  {
    "path": "/<field_name>", 
    "op": "<operation>", 
    "value": "<field_value>"
  }
]

В качестве параметров необходимо передавать:

  • field_name - название поля в базе данных

  • operation - для обновления всегда replace

  • value - значение поля

Например:

[
  {
    "path": "/Name",
    "op": "replace",
    "value": "Новое имя"
  }
]

Для обновления дополнительных реквизитов клиента необходимо передавать Dictionary с названием ClientExtra. В словаре должны быть пары "код":"значение", где код - код (имя в базе) дополнительного реквизита.

Например:

[
  {
    "path": "/ClientExtra",
    "op": "replace",
    "value": {"language":"ru"}
  }
]

 

Помогла ли вам статья?