Справочные функции

Модуль: common

Версия API

Показать информацию

Позволяет получить информацию о версии API.

Функция: show_api_version

Пример GET запроса:

https://api.codeblast.ru/common/show_api_version?api_version_id=2

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <api_version>api-1u4</api_version>
    <api_address>api-1u4.codeblast.ru</api_address>
    <api_status>CURRENT</api_status>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "api_version": "api-1u4",
  "api_address": "api-1u4.codeblast.ru",
  "api_status": "CURRENT",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
api_version_id number id версии API

Поля ответа:

Поле Тип Описание
api_version string версия API
api_address string адрес API
api_status string статус API «CURRENT, PREVIOUS»
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_API_VERSION_ID ошибка ввода id версии API
"[0-9]{1,20}"
API_NOT_EXISTS API данной версии не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Перечислить id версий API

Позволяет получить список id версий. Используя данный id можно получить информацию по версии API.

Функция: list_api_version_id

Пример GET запроса:

https://api.codeblast.ru/common/list_api_version_id

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <list_api_version_id>
        <api_version_id>2</api_version_id>
        <api_version_id>1</api_version_id>
    </list_api_version_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "list_api_version_id": [
    "2",
    "1"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
     

Поля ответа:

Поле Тип Описание
api_version_id string id версии API
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Сообщения

Показать сообщение

Позволяет просмотреть служебные и административные сообщения учётной записи.

Функция: show_message

Пример GET запроса:

https://api.codeblast.ru/common/show_message?token_data=data:string
                                            &message_id=263

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <message_text>Административное сообщение ...</message_text>
    <message_datetime>2014-10-20 18:26:27</message_datetime>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "message_text": "Административное сообщение ...",
  "message_datetime": "2014-10-20 18:26:27",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
message_id number id сообщения

Поля ответа:

Поле Тип Описание
message_text string текст сообщения
message_datetime datetime дата и время создания сообщения
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_MESSAGE_ID ошибка ввода id сообщения
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
MESSAGE_NOT_EXISTS сообщения не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Перечислить id сообщений

Позволяет получить список id сообщений.

Функция: list_message_id

Пример GET запроса:

https://api.codeblast.ru/common/list_message_id?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <list_message_id>
        <message_id>425</message_id>
        <message_id>782</message_id>
    </list_message_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "list_message_id": [
    "425",
    "782"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
message_id number id сообщения
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет