Provider
/api/provider/get/{name}
Получить информацию о провайдере по имени
Тип HTTP запроса: get
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| name | string | имя провайдера | path | да |
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ProviderInfo | |||
| error | Info |
/api/provider/list
Получить список провайдеров
Тип HTTP запроса: get
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ProviderInfo[] | Результат метода API. | нет | |
| error | Info |
/api/provider/getactivity/{name}
Получить текущую активность провайдера
Тип HTTP запроса: get
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| name | string | имя провайдера | path | да |
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Результат метода API. | нет | |
| error | Info |
/api/provider/setactivity
Установить активность провайдера
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры установки активности провайдера
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| providerName | string | нет | ||
| isActivity | boolean | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/api/provider/getusefiles/{name}
Получить информацию о работе провайдера с файлами
Тип HTTP запроса: get
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| name | string | имя провайдера | path | да |
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Результат метода API. | нет | |
| error | Info |
/api/provider/setusefiles
Установить возможность работы провайдера с файлами
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры установки работы провайдера с файлами
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| providerName | string | нет | ||
| useFiles | boolean | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |