Проект

Общее

Профиль

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

Rustam Usmanov, 30.06.2015 15:14

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