Перейти к основному содержимому
Версия: 1.22.3

SimpleApiResponse

Данный класс содержит методы, которые создают ответ для настроенного REST API.

внимание

Экземпляры объектов этого класса доступны только в теле скрипта действия API в виде переменной ответа.

Подробнее читайте в статье Настройки REST API.

getBody()


Используйте метод, чтобы получить тело ответа.

Возвращаемое значение:

ТипОписание
AnyМетод возвращает тело ответа.

Пример:

getBody()
(function(request, response) {
response.setBody({"key":"value"});
const responseBody = response.getBody(); // {"key":"value"}
})(SimpleApiRequest, SimpleApiResponse)

getContentType()


Используйте метод, чтобы получить формат тела ответа.

Возвращаемое значение:

ТипОписание
StringМетод возвращает формат тела ответа.

Пример:

getBody()
(function(request, response) {
const contentType = response.getContentType(); // application/json
})(SimpleApiRequest, SimpleApiResponse)

getHeaders()


Используйте метод, чтобы получить значения заголовков ответа.

Возвращаемое значение:

ТипОписание
ObjectМетод возвращает объект, ключи которого – названия заголовков.

Пример:

getBody()
(function(request, response) {
// Отправляется запрос на
// https://your-instance-url.simpleone.ru/v1/api/c_simple/api_module_path/api_action_path

const allHeaders = response.getHeaders(); // {"accept-encoding":["gzip, deflate, br"],"postman-token":...}
})(SimpleApiRequest, SimpleApiResponse)

getStatus()


Используйте метод, чтобы получить статус ответа.

Возвращаемое значение:

ТипОписание
IntegerМетод возвращает статус ответа.

Пример:

getBody()
(function(request, response) {
const status = response.getStatus(); // 200
})(SimpleApiRequest, SimpleApiResponse)

setBody(body)


Используйте метод, чтобы задать содержимое тела REST ответа.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
bodyAnyДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

getBody()
(function(request, response) {
response.setBody({"key":"value"});
const responseBody = response.getBody(); // {"key":"value"}
})(SimpleApiRequest, SimpleApiResponse)

setContentType(type)


Используйте метод, чтобы задать формат тела ответа.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
typeStringДаapplication/json

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

getBody()
(function(request, response) {
response.setContentType('text/plain');
})(SimpleApiRequest, SimpleApiResponse)

setHeader(header, value)


Используйте метод, чтобы задать значение заголовка REST ответа.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
headerStringДаНет
valueAnyДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

getBody()
(function (request, response) {
response.setHeader('BACKEND-VERSION', ss.getProperty('simple.version.back'));
response.setHeader('FRONTEND-VERSION', ss.getProperty('simple.version.front'));
})(SimpleApiRequest, SimpleApiResponse)

setStatus(status)


Используйте метод, чтобы задать кодовый номер HTTP статуса для ответа. Подробнее о возвращаемых статусах читайте в списке кодов.

Например, код статуса 200 говорит об успешном выполнении запроса, а 404 – запрошенный адрес URI не найден.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
statusIntegerДа200

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

getBody()
(function (request, response) {
response.setBody({
"support_phone": ss.getProperty('simple.auth_page.support_phone')
});
response.setStatus(200);
})(SimpleApiRequest, SimpleApiResponse)