Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Запит служить для контролю стану процесу асинхронної перевірки гешу. Якщо процес знаходиться у стадії виконання, буде повернуто HTTP статус код 202, у випадку успішного завершення - 200. В інших випадках повертаються відповідні коди 400, 500.

URL-адреса запиту

Запрос служит для получения результата проверки хеша. Запрос является блокирующим, то есть результат будет получен только после завершения процесса проверки хеша, если такой был ранее запущен. Если хеш действительный, будет возвращен HTTP статус код 200. Если в хеш не действительный или в процессе проверки возникли ошибки, будет возвращен HTTP статус код 406. При возникновении других типов ошибок, возвращаются HTTP статус коды 500 или 400.

...

https://ccs-dev-api.cipher.kiev.ua/ccs/hash/api/v1/context/{contextId}/verifier

Метод

GET

...

Параметри запиту
contextIdStringfalsetrueИдентификатор сессииІдентифікатор сесії

...

Налаштовувані заголовки

...

запиту

Отсутствует

Параметры JSON объекта запроса

...

Имя

...

Тип

...

Обязательность

...

Допустимые значения

...

Идентификатор хеш-алгоритма

Должен быть один  [SHA1, SHA224, SHA256, SHA384, SHA512, SHA512256, SHA512224, GOST3411, DSTU7564256, DSTU7564384, DSTU7564512]

...

Відсутні

ВІдповідь
Код відповіді
Ответ
Код ответаContent-typeДопустимые параметрыДопустимі параметриПриклад вмістуПример содержимого
200application/json

message
code
techMessage

{
"message" : "Операція успішно виконана",
"code" : "CCSCLIB-14",
"techMessage" : "OperationId:HASH_VERIFY"

}
202application/json

message

code

techMessage

{
    "message" : "Операція знаходиться в черзі на виконання",
"code" : "CCSCLIB-12",
"techMessage" : "OperationId:HASH_VERIFY"

}
202application/json

message
code
techMessage

{
"message" : "Операція знаходиться на виконанні",
"code" : "CCSCLIB-13",
"techMessage" : "OperationId:HASH_VERIFY"
}
400application/json

message
code
techMessage

{
    "message" : "Операція ще не була запущена",
"code" : "CCSCLIB-11",
"techMessage" : "OperationId:HASH_VERIFY"

}
500application/json

message

code

techMessage

{

    "message" : "Виконання операції завершено, але результат виконання не визначений", 
"code" : "CCSCLIB-16",
"techMessage" : "OperationId:HASH_VERIFY"

}
500application/json

message
code
techMessage

{
    "message" : "Виникла помилка під час виконаня операції",
"code" : "CCSCLIB-15",
"techMessage" : "OperationId:HASH_VERIFY"

}

...

Параметри JSON об'єкта відповіді
ПараметрТип
данных
даних
Описание
Опис
messageString
Описание результата проведения операции
Опис результату проведення операції
codeStringКод
операции
операції
techMessageString
Расширенное техническое описание.
Пример кода на JavaScript + jQuery 2.2.4

...

languagejs

...

Розширений технічний опис