REST API on База знаний DataMobile

Структура запросов

Mon, 01 Jan 0001 00:00:00 +0000

HTTP-параметры


POST|GET|PUT|DELETE 
http|https://<api>/<resources>/<resource_id>/?<param1>=<value1>&<param2>=<value2> HTTP/1.1

HTTP-заголовки


 "headers": {
 "Authorization": "Basic dHNkdXNlcjoxMjM=", \\ токен в base64 "Basic tsduser:123"
 "App-Version": "3.8.0", \\ версия приложения (str)
 "Content-Length": "78", \\ длина тела запроса
 "App-Version-Code": "3008000", \\ версия приложения (int)
 "Content-Type": "application/json; charset=UTF-8" \\ тип контента
 }

Тело запроса

Тело запроса может изменяться в зависимости от используемого метода. Информация должна передаваться в формате JSON.

Примечание

С описанием возможных полей и структурой тела вы можете познакомиться в разделах, посвященных запросам к API.

Структура ответов

Mon, 01 Jan 0001 00:00:00 +0000

Параметры

Наименование	Описание	Значение
status_code	Код ответа	200 – успешный ответ 900 – исключение для вывода в диалог 901 – исключение для вывода в снекбар
error	Причина ошибки	-
Content-Type	Тип контента	application/json; charset=utf-8

Тело ответа

Тело ответа содержит информацию, необходимую для создания или изменения объекта. Информация должна передаваться в формате JSON. С описанием возможных полей и структурой тела вы можете познакомиться в разделах, посвященных запросам к API.

Пример


status_code: 200
reason: okhttp/4.9.0
Content-Type: application/json; charset=UTF-8
...

{json-object | json-array}

Полезные статьи

Структура запросов

Исключения

Mon, 01 Jan 0001 00:00:00 +0000

Коды ответов

Код	Описание
200	Успешный ответ
900	Исключение для вывода в диалог
901	Исключение для вывода в снекбар

Тело исключения

Наименование	Тип	Описание
title	string	Заголовок
description	string	Исключение

Пример


status_code: 901
reason: error
Content-Type: application/json; charset=UTF-8


{
 "title": "Заголовок",
 "description": "Исключение"
}