Данный объект используется во многих методах API уровня пользователя и содержит унифицированные поля, значения которых могут отличаться в зависимости от вызываемого метода.
| Параметр | Назначение | Описание |
|---|---|---|
| ClientIntegrationId | Токен клиента (string) | |
| PhoneNumber | Номер телефона клиента (string) | |
| ClientName | Наименование клиента (sring) | |
| ObjectId | Свойство может быть использовано для передачи кода объекта, над которым необходимо совершить какое либо действие | Значение параметра активно используется для получения детальной информации о том или ином объекте системы, связанном с клиентом. Например, в данном поле можно передать код заявки, при получении информации по конкретной заявке клиента. |
| ObjectDescriptorLong | Свойство используется для детализации данных переданного объекта в ObjectId (long) | Значение зависит от вызываемого метода |
| ObjectDescriptorString | Свойство используется для детализации данных переданного объекта в ObjectId (string) | Значение зависит от вызываемого метода |
| SetLog | При TRUE идет запись в лог входных и выходных параметров (bool) |
Пример объекта запроса для методов уровня системы
{
ClientIntegrationId: "",
PhoneNumber: "79629031736",
ClientName: "Белоусов Максим",
ObjectId: 0,
ObjectDescriptorLong: "",
ObjectDescriptorString: "",
SetLog: false
}
Данный запрос может быть использован в методе добавления клиента AddClient (см. подробнее AddClient)
Пример объекта запроса для методов уровня пользователя
{
ClientIntegrationId: "skfj78892f",
PhoneNumber: "",
ClientName: "",
ObjectId: 198865,
ObjectDescriptorLong: "",
ObjectDescriptorString: "",
SetLog: false
}
Данный запрос может быть использован для получения информации по какому-либо объекту системы, связанному с клиентом (например, договор).