75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
## Создание клиента
|
||
|
||
Используется endpoint с методом POST
|
||
|
||
Предлагаемый вариант
|
||
`api/1.0/openRequest/createClient`
|
||
### Запрос
|
||
|
||
```json
|
||
{
|
||
"companyId": "", // Компания
|
||
"typeId": "", // Тип заявки
|
||
"kindId": "", // Вид заявки
|
||
"name": "Альфа-Пласт",
|
||
"shortName": "Альфа-Пласт",
|
||
"managerId": "123456", // Значение ИНС (залили данные в AD и храним их в CRM. Значение без нулей в начале)
|
||
"accountId": "57ef229c-d8e4-4da5-b87a-7205e7eb7c42"
|
||
}
|
||
```
|
||
|
||
### Ответ
|
||
|
||
Успешный
|
||
```json
|
||
{
|
||
"success": true,
|
||
"errorMessage": ""
|
||
}
|
||
```
|
||
|
||
Неуспешный
|
||
```json
|
||
{
|
||
"success": false,
|
||
"errorMessage": "Текст ошибки"
|
||
}
|
||
```
|
||
## Проверка готовности создания клиента
|
||
|
||
Используется endpoint с методом GET
|
||
|
||
Предлагаемый вариант
|
||
`api/1.0/openRequest/view?accountId={accountId}`
|
||
|
||
Главная суть метода, что мы по значению `accountId` из пункта `Создание клиента` получаем готовность создания клиента.
|
||
Клиент считается созданным, если у него заполнено поле `ClientId` (уточнить как называется в базе данных поле `Код клиента из R3`)
|
||
### Ответ
|
||
|
||
Клиент еще создается
|
||
```json
|
||
{
|
||
"status": "Waiting",
|
||
"clientId": "",
|
||
"errorMessage": ""
|
||
}
|
||
```
|
||
|
||
Создание клиента завершено
|
||
```json
|
||
{
|
||
"status": "Done",
|
||
"clientId": "123-123-123",
|
||
"errorMessage": ""
|
||
}
|
||
```
|
||
|
||
Ошибка при создании клиента
|
||
```json
|
||
{
|
||
"status": "Error",
|
||
"clientId": "",
|
||
"errorMessage": "Описание ошибки"
|
||
}
|
||
```
|