Створення картки сертифіката¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло HTTP запиту/відповіді в json форматі) |
URL запиту |
https://edo.edin.ua/Api/V1/Certificate/Create |
Параметри, що передаються в URL (разом з адресою методу) |
-//- |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
Таблиця 1 - Опис json-параметрів запиту
Параметр |
Mandatory/Optional |
Формат |
Опис |
---|---|---|---|
varToken |
M |
String |
токен, отриманий при авторизації |
cert_number |
M |
String(100) |
номер сертифіката |
cert_date |
M |
String «DD.MM.YYYY» |
дата видачі сертифіката |
cert_sub_type |
M |
String |
вид сертифіката (код із довідника) |
cert_type |
M |
String |
тип сертифіката (код із довідника) |
cert_start_date |
M |
String «DD.MM.YYYY» |
дата початку дії сертифіката |
cert_end_date |
M…O |
String «DD.MM.YYYY» |
дата закінчення дії сертифіката. Поле обов’язкове лише за cert_sub_type=1 |
cert_part_number |
M…O |
String(100) |
номер партії. Поле обов’язкове лише за cert_sub_type=2 |
cert_gln_creator |
M |
String |
GLN власника сертифіката (GLN авторизованого користувача) |
cert_lot_number |
O |
String(50) |
артикул виробника |
cert_gtd |
O |
String(100) |
номер ГТД |
Примітка
При створенні картки виконуються наступні перевірки:
Перевірка на наявність сертифікату з таким номером в сервісі, де власник є GLN, який передає поле «cert_gln_creator», якщо є - повертається помилка (детальніше в Описі помилок)
GLN в полі «cert_gln_creator» повинен бути підв’язаний під авторизованого користувача, якщо не підв’язаний - повертається помилка (детальніше в Описі помилок)
Дата початку дії (cert_start_date) не повинна бути більшою, ніж дата закінчення дії (cert_end_date), якщо більше - повертається помилка (детальніше в Описі помилок)
RESPONSE
Таблиця 2 - Опис json-параметрів відповіді метода API
Параметр |
Mandatory/Optional |
Формат |
Опис |
---|---|---|---|
certificate_id |
int |
id створеного сертифіката |
|
varMessage |
String |
повідомлення сервера |
|
intCode |
int |
код відповіді сервера |
Приклади¶
Приклад тіла запиту в json форматі:
{
"varToken":"nohuola9h24tmj4jln3devi151",
"cert_number":"Test_api_4",
"cert_date":"05.06.2018",
"cert_sub_type":"1",
"cert_type":"8",
"cert_start_date":"30.06.2018",
"cert_end_date":"29.07.2018",
"cert_part_number":"part_numb_api_1",
"cert_gln_creator":"9864066822454",
"cert_lot_number":"lot_numb_api_1",
"cert_gtd":"gtd_api_1"
}
Приклад тіла відповіді в json форматі:
{
"certificate_id": "2121",
"varMessage": "Success!",
"intCode": 200
}
Опис помилок роботи методу створення картки сертифіката¶
Якщо в запиті не заповнено одне з обов’язкових полей (cert_number / cert_date / cert_sub_type / cert_type / cert_start_date / cert_end_date / cert_part_number / cert_gln_creator):
{
"varMessage": "Не заполнено обязательное поле "cert_number",
"intCode": 400
}
Якщо в запиті в полях cert_number / cert_part_number / cert_lot_number / cert_gtd передана кількість символів більша допустимого (таблиця 1), наприклад,
"поле":"r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5"
:
{
"varMessage": "Недопустимый формат поля "поле" r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5, максимальное количество символов N",
"intCode": 400
}
Якщо в запиті в полі cert_gln_creator передано значення неправильного формату (
"cert_gln_creator":"sdfgsdfsfdgsdf"
):
{
"varMessage": "Недопустимый формат поля \"cert_gln_creator\" sdfgsdfsfdgsdf",
"intCode": 400
}
Якщо в запиті в полі cert_sub_type передано некорректне значення ключа (
"cert_sub_type":"fsew"
):
{
"varMessage": "Недопустимый формат поля \"cert_sub_type\" fsew, вид сертификата не найден",
"intCode": 400
}
Якщо в запиті в полі cert_type передано некорректне значення ключа (
"cert_type":"fsew"
):
{
"varMessage": "Недопустимый формат поля \"cert_type\" fsew, тип сертификата не найден",
"intCode": 400
}
Якщо в запиті в «полі_дати» ( cert_date / cert_start_date / cert_end_date ) передано некорректне значення ключа (відмінне від DD.MM.YYYY), наприклад,
"поле_дата":"wetryert"
:
{
"varMessage": "Недопустимый формат поля \"поле_дата\" wetryert, формат даты DD.MM.YYYY",
"intCode": 400
}
Якщо в запиті передано номер сертифіката (cert_number), котрий вже є під GLN користувача (дублювання):
{
"varMessage": "Сертификат с номером Test_api_20 уже создан",
"intCode": 404
}
Якщо в запиті передано GLN (
"cert_gln_creator":"4607164999995"
), котрий не підв’язаний під користувачем:
{
"varMessage": "Gln 4607164999995 не найден",
"intCode": 404
}
Якщо дата початку (cert_start_date) більша за дату закінчення (cert_end_date):
{
"varMessage": "Дата начала 30.06.2018 не может быть больше даты окончания 12.05.2018",
"intCode": 400
}