Changes between Version 64 and Version 65 of Taskforces/FCS/FCS-Specification-Draft

Timestamp:

06/13/17 14:14:10 (7 years ago)

Author:

Leif-Jöran

Comment:

Adding operation=searchRetrieve 2.0 example querytype=cql in addition to the queryType=fcs one

Taskforces/FCS/FCS-Specification-Draft

@@ -989 +989 @@
 }}}
 
-Moving to a SRU 2.0 example which shows a request and response to a ''searchRetrieve'' request with a ''queryType=fcs'' query for ''[word = "användning"]'':
+Moving to a SRU 2.0. We introduce the `queryType` parameter. The same query would then become:
+* HTTP GET request: Client → Endpoint:
+{{{#!sh
+http://localhost:8080/korp-endpoint/sru?operation=searchRetrieve&queryType=cql&query=%22anv%C3%A4ndning%22 
+}}}
+* HTTP Response: Endpoint → Client:
+{{{#!xml
+<?xml version='1.0' encoding='utf-8'?>
+<sruResponse:searchRetrieveResponse>
+  <sruResponse:version>2.0</sruResponse:version>
+  <sruResponse:numberOfRecords>33260</sruResponse:numberOfRecords>
+  <sruResponse:records>
+    <sruResponse:record>
+      <sruResponse:recordSchema>http://clarin.eu/fcs/resource</sruResponse:recordSchema>
+      <sruResponse:recordXMLEscaping>xml</sruResponse:recordXMLEscaping>
+      <sruResponse:recordData>
+        <fcs:Resource pid="ABOUNDERRATTELSER2012-32245">
+          <fcs:ResourceFragment>
+            <fcs:DataView type="application/x-clarin-fcs-hits+xml">
+              <hits:Result>Youtube-videon har väckt debatt om polisernas <hits:Hit>användning</hits:Hit> av våld .</hits:Result>
+            </fcs:DataView>
+          </fcs:ResourceFragment>
+        </fcs:Resource>
+      </sruResponse:recordData>
+      <sruResponse:recordPosition>1</sruResponse:recordPosition>
+    </sruResponse:record>
+    <!-- 249 records not shown -->
+  </sruResponse:records>
+  <sruResponse:nextRecordPosition>251</sruResponse:nextRecordPosition>
+  <sruResponse:echoedSearchRetrieveRequest>
+  <sruResponse:version>2.0</sruResponse:version>
+  <sruResponse:query>"användning"</sruResponse:query>
+  <sruResponse:xQuery>
+    <searchClause>
+      <index>cql.serverChoice</index>
+      <relation><value>=</value></relation>
+      <term>användning</term>
+    </searchClause>
+  </sruResponse:xQuery>
+  <sruResponse:startRecord>1</sruResponse:startRecord>
+</sruResponse:echoedSearchRetrieveRequest>
+<sruResponse:resultCountPrecision>info:srw/vocabulary/resultCountPrecision/1/exact</sruResponse:resultCountPrecision>
+</sruResponse:searchRetrieveResponse>
+}}}
+
+And for ''queryType'' with value ''fcs'' using FCS-QL we get a request and response to the ''searchRetrieve'' request with queryType ''fcs'' and query ''[word = "användning"]'':
 * HTTP GET request: Client → Endpoint:
 {{{#!sh
@@ -1076 +1121 @@
   <sruResponse:startRecord>1</sruResponse:startRecord>
 </sruResponse:echoedSearchRetrieveRequest>
-<sruResponse:resultCountPrecision>info:srw/vocabulary/resultCountPrecision/1/exact</sruResponse:resultCountPrecision></sruResponse:searchRetrieveResponse>
+<sruResponse:resultCountPrecision>info:srw/vocabulary/resultCountPrecision/1/exact</sruResponse:resultCountPrecision>
+</sruResponse:searchRetrieveResponse>
 }}}