Проект

Общее

Профиль

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

Rustam Usmanov, 14.04.2015 15:56

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 10 Rustam Usmanov
83 3 Rustam Usmanov
<pre><code class="xml">
84
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
85
<ns1:NCIPMessage xmlns:ns1="http://www.niso.org/2008/ncip">
86
  <ns1:RequestItemResponse>
87
    <ns1:Problem>
88
      <ns1:ProblemType>Diagnostic [220] Additional Info : </ns1:ProblemType>
89 1 Rustam Usmanov
      <ns1:ProblemDetail>220: </ns1:ProblemDetail>
90 4 Rustam Usmanov
    </ns1:Problem>
91
  </ns1:RequestItemResponse>
92 1 Rustam Usmanov
</ns1:NCIPMessage>
93
</code></pre>
94
95 9 Rustam Usmanov
Ответ JSON (неуспешное завершение):
96
97
<pre><code class="json">
98
{
99
    "RequestItemResponse": {
100
        "Problem": {
101
            "ProblemType": {
102
                "value": "Diagnostic [220] Additional Info : "
103
            },
104
            "ProblemDetail": "220: "
105
        }
106
    }
107
}
108
</code></pre>
109
110
Ответ XML(успешное завершение):
111 4 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:UserId>
116
      <ns1:AgencyId>19013582</ns1:AgencyId>
117
      <ns1:UserIdentifierValue>sip</ns1:UserIdentifierValue>
118
    </ns1:UserId>
119
    <ns1:RequestType ns1:Scheme="http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm">Hold</ns1:RequestType>
120
    <ns1:RequestScopeType ns1:Scheme="http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm">Bibliographic Item</ns1:RequestScopeType>
121
    <ns1:RequestId>
122
      <ns1:RequestIdentifierValue>302</ns1:RequestIdentifierValue>
123 1 Rustam Usmanov
    </ns1:RequestId>
124
  </ns1:RequestItemResponse>
125
</ns1:NCIPMessage>
126 9 Rustam Usmanov
</code></pre>
127
128
Ответ JSON (успешное завершение):
129
130
<pre><code class="json">
131
{
132
    "RequestItemResponse": {
133
        "UserId": {
134
            "AgencyId": {
135
                "value": "19013582"
136
            },
137
            "UserIdentifierValue": "002"
138
        },
139
        "RequestType": {
140
            "value": "Hold",
141
            "Scheme": "http://www.niso.org/ncip/v1_0/imp1/schemes/requesttype/requesttype.scm"
142
        },
143
        "RequestScopeType": {
144
            "value": "Bibliographic Item",
145
            "Scheme": "http://www.niso.org/ncip/v1_0/imp1/schemes/requestscopetype/requestscopetype.scm"
146
        },
147
        "RequestId": {
148
            "RequestIdentifierValue": "373"
149
        }
150
    }
151
}
152 1 Rustam Usmanov
</code></pre>