Changes between Version 26 and Version 27 of FCS-specification

Timestamp:

01/07/13 11:11:05 (11 years ago)

Author:

oschonef

Comment:

minor formatting

FCS-specification

@@ -53 +53 @@
 
 == Referring to an SRU endpoint from a CMDI file ==
-This can be done with a !ResourceProxy where:
- * !ResourceType = !SearchService
- * mimetype = application/sru+xml
+This can be done with a !ResourceProxy with {{{ResourceType}}} set to {{{SearchService}}} and {{{mimetype}}} set to {{{application/sru+xml}}}:
 {{{#!xml
  <ResourceProxy id="d55">
@@ -252 +250 @@
 
 ==== Restricting the search ====
-In general, an endpoint is '''required''' to accept an unrestricted search and perform the search operation on all resources. An agent can ask an endpoint to restrict the search to a sub-set of the available resources. This is done by passing a comma-separated list of resource identifiers (!MdSelfLinks obtained from a scan operation) in the {{{x-cmd-context}} parameter of the !SearchRetrieve request. The list can get extensive, but an agent can use HTTP POST instead of HTTP GET, which means that the parameters would be passed in the body of the HTTP request instead of appending them to the URL. This has the consequence that the practical limit for the number of !MdSelfLinks and other arguments becomes a lot higher.
+In general, an endpoint is '''required''' to accept an unrestricted search and perform the search operation on all resources. An agent can ask an endpoint to restrict the search to a sub-set of the available resources. This is done by passing a comma-separated list of resource identifiers (!MdSelfLinks obtained from a scan operation) in the {{{x-cmd-context}}} parameter of the !SearchRetrieve request. The list can get extensive, but an agent can use HTTP POST instead of HTTP GET, which means that the parameters would be passed in the body of the HTTP request instead of appending them to the URL. This has the consequence that the practical limit for the number of !MdSelfLinks and other arguments becomes a lot higher.
 
 For example, in order to only search for the occurrence of the string "bellen" within the CGN corpus as offered by our hypothetical endpoint (used throughout this document) we could format the !SearchRetrieve query as follows: \\
-{{{http://clarin_sru_endpoint?version=1.2&operation=searchRetrieve&x-cmd-context=hdl:1839/00-0000-0000-0001-53A5-2&query=bellen}}} \\
+{{{http://endpoint.example.org?version=1.2&operation=searchRetrieve&query=bellen&x-cmd-context=hdl:1839/00-0000-0000-0001-53A5-2}}}
 
 ==== Query Expansion ====