Introduction
Документация Solr search API платформы RS Edu / RKI.
Документация JSON-endpoint'ов поискового API RS Edu.
Формат ответа
Успешный ответ:
{
"success": true,
"message": "Текст сообщения",
"data": {}
}
Ошибка:
{
"success": false,
"message": "Текст ошибки",
"errors": {}
}
Экспорт
Для каждого ядра доступен GET /{resource}/export — скачивание .xlsx с теми же фильтрами, что и у поиска.
Authenticating requests
This API is not authenticated.
Общее
Количество материалов по ядрам
Возвращает total по каждому Solr-ядру. Параметр exclude исключает одно ядро из ответа.
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/total" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"exclude\": \"interactives\"
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/total"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"exclude": "interactives"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Книги
Поиск книг
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/books/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"publishers_ids\": [
16
],
\"start_year\": 16,
\"end_year\": 16,
\"has_audios\": false,
\"has_videos\": true,
\"available\": false,
\"organization_id\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/books/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"publishers_ids": [
16
],
"start_year": 16,
"end_year": 16,
"has_audios": false,
"has_videos": true,
"available": false,
"organization_id": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт книг в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/books/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"publishers_ids\": [
16
],
\"start_year\": 16,
\"end_year\": 16,
\"has_audios\": true,
\"has_videos\": true,
\"available\": false,
\"organization_id\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/books/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"publishers_ids": [
16
],
"start_year": 16,
"end_year": 16,
"has_audios": true,
"has_videos": true,
"available": false,
"organization_id": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Рабочие листы
Поиск рабочих листов
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/worksheets/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": true,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": false,
\"duration\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/worksheets/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": true,
"organization_id": 16,
"has_audios": false,
"has_videos": false,
"duration": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт рабочих листов в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/worksheets/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": true,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": true,
\"duration\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/worksheets/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": true,
"organization_id": 16,
"has_audios": false,
"has_videos": true,
"duration": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Тесты
Поиск тестов
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/tests/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": false,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": false,
\"duration\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/tests/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": false,
"organization_id": 16,
"has_audios": false,
"has_videos": false,
"duration": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт тестов в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/tests/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": false,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": false,
\"duration\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/tests/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": false,
"organization_id": 16,
"has_audios": false,
"has_videos": false,
"duration": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Интерактивы
Поиск интерактивов
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/interactives/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": true,
\"organization_id\": 16,
\"has_audios\": true,
\"has_videos\": true
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/interactives/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": true,
"organization_id": 16,
"has_audios": true,
"has_videos": true
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт интерактивов в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/interactives/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": true,
\"organization_id\": 16,
\"has_audios\": true,
\"has_videos\": false
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/interactives/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": true,
"organization_id": 16,
"has_audios": true,
"has_videos": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Банк материалов
Поиск материалов банка
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/materials/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": true,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": false
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/materials/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": true,
"organization_id": 16,
"has_audios": false,
"has_videos": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт материалов банка в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/materials/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": true,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": true
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/materials/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": true,
"organization_id": 16,
"has_audios": false,
"has_videos": true
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Методики
Поиск методик
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/methodologies/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": false,
\"organization_id\": 16,
\"has_audios\": false,
\"has_videos\": true
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/methodologies/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": false,
"organization_id": 16,
"has_audios": false,
"has_videos": true
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт методик в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/methodologies/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"category_id\": 16,
\"categories_ids\": [
16
],
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16,
\"available\": false,
\"organization_id\": 16,
\"has_audios\": true,
\"has_videos\": true
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/methodologies/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"category_id": 16,
"categories_ids": [
16
],
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16,
"available": false,
"organization_id": 16,
"has_audios": true,
"has_videos": true
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Лексический минимум
Поиск лексического минимума
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/dictionary_words/get" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/dictionary_words/get"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (500):
Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
{
"message": "Server Error"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Экспорт лексического минимума в Excel
Example request:
curl --request GET \
--get "http://rsedu-srch-v1-api.local/dictionary_words/export" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start\": 16,
\"limit\": 22,
\"sort_by\": \"architecto\",
\"levels_ids\": [
16
],
\"collections_ids\": [
16
],
\"collection_id\": 16
}"
const url = new URL(
"http://rsedu-srch-v1-api.local/dictionary_words/export"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"start": 16,
"limit": 22,
"sort_by": "architecto",
"levels_ids": [
16
],
"collections_ids": [
16
],
"collection_id": 16
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.