API. Работа с выходными сведениями периодических изданий (газет или журналов)
Работа с выходными сведениями периодических изданий (газет или журналов)
4. Добавление выходных сведений периодических изданий (газет или журналов)
4.1. Пример запроса
{
"jsonrpc": "2.0",
"method": "imprint.add",
"params": {
"type": 1,
"title": "ИТ Арктика",
"issn": "5500-2200",
"massMediaNumber": "ЭЛ №ФС77 - 68679"
},
"id": 1
}
4.2. Передаваемые поля (полужирным помечены поля, обязательные для заполнения):
|
Ключ |
Тип значения |
Расшифровка |
|
type |
целое число из списка 1 = журнал 2 = газета |
Тип периодического издания |
|
title |
строка |
Заглавие произведения |
|
issn |
строка |
ISSN |
|
massMediaNumber |
строка |
Номер свидетельства регистрации СМИ |
4.3. Примеры ответов
Успешный ответ:
{
"jsonrpc": "2.0",
"result": {
"imprintId": 1234
},
"id": 1
}
Здесь imprintId – это идентификатор выходных сведений, присвоенный системой ОЭК РГБ. Он вам понадобится для добавления экземпляров журналов и газет в систему.
Ответ с описанием возникшей ошибки:
{
"jsonrpc": "2.0",
"error": {
"code": -32602,
"message": "Invalid params",
"data": {
"massMediaNumber": "Значение должно быть строкой."
}
},
"id": 1
}
5. Получение сведений о выходных сведениях периодических изданий (газет или журналов)
5.1. Пример запроса:
{
"jsonrpc": "2.0",
"method": "imprint.get",
"params": {
"imprintId": 1234
},
"id": 1
}
5.2. Пример ответа:
{
"jsonrpc": "2.0",
"result": {
"type": 1,
"title": "ИТ Арктика",
"issn": "5500-2200",
"massMediaNumber": "ЭЛ №ФС77 - 68679",
"imprintId": 1234,
"isEditable": true,
"isCreatedViaApi": true
},
"id": 1
}
isEditable – флаг, уведомляющий о возможности редактирования данных выходных сведений
isCreatedViaApi – флаг, информирующий о том, каким образом были созданы данные выходные сведения: через API (true) или через web-интерфейс (false)
6. Редактирование выходных сведений периодических изданий (газет и журналов)
Редактирование выходных сведений доступно до тех пор, пока ни одна заявка, в которой указаны данные выходные сведения, не была отправлена на ручную проверку операторами системы (что происходит при успешной подписи заявки с помощью ЭЦП). Узнать о доступности редактирования можно с помощью анализа значения поля isEditable, возвращаемого при запросе данных методом imprint.get (см. п.5).
6.1. Пример запроса:
{
"jsonrpc": "2.0",
"method": "imprint.edit",
"params": {
"imprintId": 1234,
"issn": "7700-3355"
},
"id": 1
}
imprintId является обязательным полем, содержащим идентификатор выходных сведений, присвоенный системой ОЭК РГБ.
Изменения будут внесены только в указанные поля. Прочие поля сохранят своё оригинальное значение.
7. Просмотр списка выходных сведений периодических изданий (газет и журналов)
7.1. Пример запроса:
{
"jsonrpc": "2.0",
"method": "imprint.list",
"params": {
"itemsOnPage": 10,
"currentType": 1,
"currentPage": 1
},
"id": 1
}
7.2. Передаваемые поля (полужирным помечены поля, обязательные для заполнения):
|
Ключ |
Тип значения |
Расшифровка |
|
currentType |
целое число из списка -1 = все 1 = журнал 2 = газета |
Тип периодического издания (по умолчанию -1) |
|
currentPage |
целое число > 0 |
Текущая страница (по умолчанию 1) |
|
itemsOnPage |
целое число > 0 или -1 для вывода всех элементов |
Количество элементов на страницу (по умолчанию 20) |
7.3. Пример ответа:
{
"jsonrpc": "2.0",
"result": [
{
"type": 1,
"title": "ИТ Арктика",
"issn": "5500-2200",
"massMediaNumber": "ЭЛ №ФС77 - 68679",
"imprintId": 1234,
"isEditable": true,
"isCreatedViaApi": true
},
{
"type": 2,
"title": "Моя газета",
"issn": "1234-1234",
"massMediaNumber": "ЭЛ №ФС77 - 77700",
"imprintId": 1225,
"isEditable": false,
"isCreatedViaApi": true
}
],
"id": 1
}