ФОРМАТ ПРОТОКОЛА JSON RPC

Формат протокола JSON RPC

Протокол передачи между вашей информационной системей (далее просто ИС)  и сервером, использующий JSON-формат, поддерживает спецификацию JSON-RPC v2.0 и соответствует данному стандарту. Все дополнительные типы данных описываются отдельно, дополняя существующие в спецификации типы данных.

Объект запроса в JSON-RPC v2.0

Согласно стандарту JSON-объект запроса должен содержать:

  • значение "jsonrpc":"2.0", указывающее на версию спецификации JSON-RPC;
  • параметр method со значением метода бизнес-логики;
  • параметр params с объектом передаваемых параметров;
  • параметр id со строковым значением.

Объект ответа в JSON-RPC v2.0

Согласно стандарту JSON-объект запроса должен содержать значение "jsonrpc":"2.0", указывающее на версию спецификации JSON-RPC, а также параметр id со строковым значением, аналогично объекту запроса.

Если произошла ошибка, в JSON-объекте ответа должно появиться значение error, которое будет описано дальше. Если методы выполнился успешно, в JSON-объекте ответа появится значение result со значением, которое вернул метод. В отличие от error, значение result не имеет чёткого формата и зависит от того, что вернул метод. Например, если метод вернул null, то в JSON-объекте ответа появится "result":null.

Объект ошибки в JSON-RPC v2.0

Объект ошибки содержит следующие поля:

  • code – целочисленный код ошибки;
  • message – текстовое сообщение об ошибке;
  • опциональный параметр data, который в данный момент используется в СБИС 3 для передачи информации о типе исключения иtraceback места возникновения исключения с сервера на клиент.
  • Также дополнительно приходит параметр details, который не показывается пользователю в сообщении, но перед отправкой логируется именно это детальное сообщение с подробным описанием причины проблемы.
0
0
Оставьте свой отзыв:
ОТПРАВИТЬ