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