Метод «Сгенерировать новый регистрационный номер, используя код шаблона»¶
Endpoint: POST {hostname}/ldm-numerator-service/api/v1/numbers/generateByCode
Метод позволяет создать новый регистрационный номер на основе кода шаблона.
Более подробное описание метода находится в yaml файле «numerator_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| correlationKey | Header | Опциональный ключ корреляции |
| idempotencyKey | Header | Ключ уникальности запроса |
| numeratorCode | Body | Код шаблона, полученный методом GET {hostname}/ldm-numerator-service/api/v1/numerators |
| timeZoneOffset | Body | Значение согласно описанию в зависимости от потребностей клиента |
| tenant | Body | Значение согласно описанию в зависимости от потребностей клиента |
| objectClassCode | Body | Код класса. Значение согласно описанию в зависимости от потребностей клиента |
| properties: - additionalProp1 - additionalProp2 - additionalProp3 |
Body | Список свойств класса. Значения согласно описанию в зависимости от потребностей клиента |
| externalParameters: - additionalProp1 - additionalProp2 - additionalProp3 |
Body | Внешние параметры. Значения согласно описанию в зависимости от потребностей клиента |
Пример запроса:
curl --location 'https://ldm-docs.k8s.lan.lanit.ru/dh-gateway-api-service/ldm-numerator-service/api/v1/numbers/generateByCode' \
-header 'accept: application/json' \
-header 'correlationKey: correlationKey' \
-header 'idempotencyKey: idempotencyKey' \
-header 'Content-Type: application/json' \
-data '{
"numeratorCode": "string",
"timeZoneOffset": 0,
"tenant": "string",
"objectClassCode": "string",
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"externalParameters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}'