Проект

Общее

Профиль

Руководство пользователя » История » Версия 25

Rustam Usmanov, 28.09.2015 16:40

1 1 Rustam Usmanov
h1. Руководство пользователя
2 2 Rustam Usmanov
3 14 Rustam Usmanov
{{toc}}
4
5 21 Rustam Usmanov
h2. Получение списка баз данных, поддерживаемых сервером
6
7 22 Rustam Usmanov
Получение списка баз данных, поддерживаемых сервером, осуществляется по протоколу "WebDAV":http://tools.ietf.org/html/rfc4918. Запрос отправляется методом PROPFIND по адресу "/db" относительно корневого URL Web-сервисов. Поддерживаются выдача значений двух свойств БД:
8 23 Rustam Usmanov
* *displayname* - название БД
9
* *resourcetype* - тип ресурса (постоянное значение "collection")
10 22 Rustam Usmanov
11 1 Rustam Usmanov
h2. Получение метаданных базы данных
12
13 23 Rustam Usmanov
Получение метаданных базы данных, осуществляется по протоколу "SRU 2.0":http://www.loc.gov/standards/sru/sru-2-0.html (сервис Explain). Запрос отправляется методом GET по адресу "/db/name" относительно корневого URL Web-сервисов, где name - название БД, метаданные для которой требуется получить. В ответной записи Explain поддерживается выдача следующих элементов метаданных:
14
* *indexInfo/set/@identifier* - идентификатор набора поисковых атрибутов
15
* *recordInfo/recordSyntax/@identifier* - идентификатор основного формата записей
16 21 Rustam Usmanov
17 13 Rustam Usmanov
h2. Поиск и извлечение записей
18
19
Поиск и извлечение записей осуществляются по протоколу "SRU 2.0":http://www.loc.gov/standards/sru/sru-2-0.html. Поддерживаются:
20 16 Rustam Usmanov
* Язык запросов "PQF":http://www.indexdata.com/yaz/doc/tools.html#PQF (*queryType=pqf*) - для работы со всеми БД Руслан.
21 19 Rustam Usmanov
* Язык запросов "CQL":http://www.loc.gov/standards/sru/cql/spec.html - только в части работы с результирующим множеством (например, *query=cql.resultSetId=default*).
22 16 Rustam Usmanov
* Одновременное использование нескольких результирующих множеств. Создание и удаление результирующих множеств осуществляется сервисом автоматически. При отсутствии в запросе на поиск параметра *resultSetTTL* создается результирующее множество с именем ??default??. В противном случае создается результирующее множество с уникальным именем.
23
* Значения ??string?? и ??xml?? параметра *recordXMLEscaping*.
24
* Ответные сообщения в форматах XML и JSON. Запрос того или иного формата осуществляется при помощи заголовка HTTP *Accept* - соотв. поддерживаются значения ??application/xml??, ??application/json??.
25
* Извлечение записей в схеме OPAC - для этого следует использовать заголовок HTTP *Accept* со значением ??application/opac+xml?? либо ??application/opac+json??.
26 18 Rustam Usmanov
* Извлечение метаданных БД (Explain).
27 13 Rustam Usmanov
28 20 Rustam Usmanov
Запрос отправляется методом GET по адресу "/db/name" относительно корневого URL Web-сервисов, где name - название БД, в которой осуществляется поиск (например, http://testbed.ruslan.ru:8080/rrs-web/db/books). Одновременный поиск в нескольких БД возможен при помощи указания в качестве названия БД нескольких названий БД, соединённых знаком "+" (например, http://testbed.ruslan.ru:8080/rrs-web/db/books+serial).
29 17 Rustam Usmanov
30 25 Rustam Usmanov
Для работы с внешними источниками данных в качестве названия БД можно использовать Z39.50 URL (например, http://testbed.ruslan.ru:8080/rrs-web/db/z39.50s://z3950.loc.gov:7090/voyager). При этом надо иметь в виду, что не все источники поддерживают кодировку UTF-8 - в таких случаях кодировку требуется указывать явно при помощи параметра *x-z3950-target-charset* (например, *x-z3950-target-charset=Windows-1251*).
31 24 Rustam Usmanov
32 3 Rustam Usmanov
h2. Заказ документа (бронирование, заказ копии)
33 1 Rustam Usmanov
34 5 Rustam Usmanov
Заказ документа осуществляется в соответствии с NISO Circulation Interchange Protocol (NCIP) v. 2.0.2. Запрос отправляется методом POST по адресу "ncip" относительно корневого URL Web-сервисов (например, http://testbed.ruslan.ru:8080/rrs-web/ncip).
35 3 Rustam Usmanov
36 6 Rustam Usmanov
h3. Входные параметры (обязательные)
37 7 Rustam Usmanov
38 16 Rustam Usmanov
* Идентификатор пользователя, от имени которого осуществляется заказ - *UserId/UserIdentifierValue*.
39
* Идентификатор библиографической записи, описывающей объект заказа - *BibliographicId/BibliographicRecordId/BibliographicRecordIdentifier*.
40
* Идентификатор заказываемой услуги - *RequestType*. Значения: ??Hold?? - бронирование, ??Non-returnable Copy?? - копия.
41
* Область применения запроса - *RequestScopeType*. Значения: ??Bibliographic Item?? - любой экземпляр, ??Item?? - конкретный экземпляр.
42
* Идентификатор места выдачи заказа - *PickupLocation*.
43
* Идентификатор домашней организации пользователя - *UserId/AgencyId*.
44
* Идентификатор организации-держателя заказываемого документа - *BibliographicId/BibliographicRecordId/AgencyId*.
45 6 Rustam Usmanov
46 8 Rustam Usmanov
h3. Выходные параметры (обязательные)
47
48 16 Rustam Usmanov
* Идентификатор пользователя, от имени которого осуществляется заказ - *UserId/UserIdentifierValue*.
49
* Идентификатор заказываемой услуги - *RequestType*. Значения: ??Hold?? - бронирование, ??Non-returnable Copy?? - копия.
50
* Область применения запроса - *RequestScopeType*. Значения: ??Bibliographic Item?? - любой экземпляр, ??Item?? - конкретный экземпляр.
51
* Идентификатор заказа - *RequestId/RequestIdentifierValue*. Является ключом записи на заказ в БД заказов.
52
* Идентификатор домашней организации пользователя - *UserId/AgencyId*.
53
* Сведения о проблемах возникших в процессе обработки запроса - *Problem*.
54 8 Rustam Usmanov
55 9 Rustam Usmanov
Запрос XML:
56 1 Rustam Usmanov
<pre><code class="xml">
57
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
58
<ns1:NCIPMessage xmlns:ns1="http://www.niso.org/2008/ncip">
59
  <ns1:RequestItem>
60
    <ns1:UserId>
61
      <ns1:AgencyId>19013582</ns1:AgencyId>
62
      <ns1:UserIdentifierValue>sip</ns1:UserIdentifierValue>
63
    </ns1:UserId>
64
    <ns1:BibliographicId>
65
      <ns1:BibliographicRecordId>
66
        <ns1:BibliographicRecordIdentifier>RU\SPSTU\books\241</ns1:BibliographicRecordIdentifier>
67
        <ns1:AgencyId>19013582</ns1:AgencyId>
68
      </ns1:BibliographicRecordId>
69
    </ns1:BibliographicId>
70
    <ns1:RequestType ns1:Scheme="http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm">Hold</ns1:RequestType>
71
    <ns1:RequestScopeType ns1:Scheme="http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm">Bibliographic Item</ns1:RequestScopeType>
72
    <ns1:PickupLocation>СПбГПУ/ОНЛ/АбонОНЛ</ns1:PickupLocation>
73
  </ns1:RequestItem>
74 3 Rustam Usmanov
</ns1:NCIPMessage>
75
</code></pre>
76 1 Rustam Usmanov
77 9 Rustam Usmanov
Запрос JSON:
78
<pre><code class="json">
79
{
80
    "RequestItem": {
81
        "UserId": {
82
            "AgencyId": {
83
                "value": "19013582"
84
            },
85
            "UserIdentifierValue": "002"
86
        },
87
        "BibliographicId": {
88
            "BibliographicRecordId": {
89
                "BibliographicRecordIdentifier": "RU\\SPSTU\\books\\241",
90
                "AgencyId": {
91
                    "value": "19013582"
92
                }
93
            }
94
        },
95
        "RequestType": {
96
            "value": "Hold",
97
            "Scheme": "http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm"
98
        },
99
        "RequestScopeType": {
100
            "value": "Bibliographic Item",
101
            "Scheme": "http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm"
102
        },
103
        "PickupLocation": {
104
            "value": "СПбГПУ/ОНЛ/АбонОНЛ"
105
        }
106
    }
107
}
108
</code></pre>
109
110
Ответ XML (неуспешное завершение):
111 3 Rustam Usmanov
<pre><code class="xml">
112
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
113
<ns1:NCIPMessage xmlns:ns1="http://www.niso.org/2008/ncip">
114
  <ns1:RequestItemResponse>
115
    <ns1:Problem>
116
      <ns1:ProblemType>Diagnostic [220] Additional Info : </ns1:ProblemType>
117 1 Rustam Usmanov
      <ns1:ProblemDetail>220: </ns1:ProblemDetail>
118 4 Rustam Usmanov
    </ns1:Problem>
119
  </ns1:RequestItemResponse>
120 1 Rustam Usmanov
</ns1:NCIPMessage>
121
</code></pre>
122
123 9 Rustam Usmanov
Ответ JSON (неуспешное завершение):
124
<pre><code class="json">
125
{
126
    "RequestItemResponse": {
127
        "Problem": {
128
            "ProblemType": {
129
                "value": "Diagnostic [220] Additional Info : "
130
            },
131
            "ProblemDetail": "220: "
132
        }
133
    }
134
}
135
</code></pre>
136
137 11 Rustam Usmanov
Ответ XML (успешное завершение):
138 4 Rustam Usmanov
<pre><code class="xml">
139
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
140
<ns1:NCIPMessage xmlns:ns1="http://www.niso.org/2008/ncip">
141
  <ns1:RequestItemResponse>
142
    <ns1:UserId>
143
      <ns1:AgencyId>19013582</ns1:AgencyId>
144
      <ns1:UserIdentifierValue>sip</ns1:UserIdentifierValue>
145
    </ns1:UserId>
146
    <ns1:RequestType ns1:Scheme="http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm">Hold</ns1:RequestType>
147
    <ns1:RequestScopeType ns1:Scheme="http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm">Bibliographic Item</ns1:RequestScopeType>
148
    <ns1:RequestId>
149
      <ns1:RequestIdentifierValue>302</ns1:RequestIdentifierValue>
150 1 Rustam Usmanov
    </ns1:RequestId>
151
  </ns1:RequestItemResponse>
152
</ns1:NCIPMessage>
153 9 Rustam Usmanov
</code></pre>
154
155
Ответ JSON (успешное завершение):
156
<pre><code class="json">
157
{
158
    "RequestItemResponse": {
159
        "UserId": {
160
            "AgencyId": {
161
                "value": "19013582"
162
            },
163
            "UserIdentifierValue": "002"
164
        },
165
        "RequestType": {
166
            "value": "Hold",
167
            "Scheme": "http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm"
168
        },
169
        "RequestScopeType": {
170
            "value": "Bibliographic Item",
171
            "Scheme": "http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm"
172
        },
173
        "RequestId": {
174
            "RequestIdentifierValue": "373"
175
        }
176
    }
177
}
178 1 Rustam Usmanov
</code></pre>