Changes between Version 58 and Version 59 of Discovery/DiscoveryWebServiceMEDIN


Ignore:
Timestamp:
02/03/10 11:52:58 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Discovery/DiscoveryWebServiceMEDIN

    v58 v59  
    218218}}} 
    219219 
     220==== Choice of Retrieve criteria: <!OrderBy>, <!RecordDetail> and <!MetadataFormat> ==== 
     221 
     222===== Ordering  ===== 
     223Ordering of the result set can optionally be requested by providing an <!OrderBy> element containing one or more <!OrderByField>s, each with an optional associated <!OrderByDirection> (default : descending). Available fields for use as an <!OrderByField> are listed in the [#OrderByFieldsList OrderByFieldList]. 
     224 
     225 
     226===== RecordDetail ===== 
     227The optional <!RecordDetail> element enables selection of the level of detail included in each result returned in the search result. Values must be one of those available from the [#RecordDetailList RecordDetailList]. Default is DocumentId, which simply returns the id of the document corresponding to the result. See [#SearchResults Search Results] section for further explanation of the structures returned in each of these cases. 
     228 
     229 
     230===== MetadataFormat ===== 
     231The optional <MetadataFormat> element can be used to restrict the search to records in the discovery index whose original (harvested) representation was in the format specified. The format must be one of the values listed in the [#metadataFormatList metadataFormatList] available from the getList operation. Default behaviour if this element is omitted is not to restrict the search in this way (and return results irrepsective of their harvested format). 
     232 
     233 
     234 
    220235==== Paging : <Start> and <!HowMany> ==== 
    221236The optional elements <Start> and <!HowMany> control which records from the result set should be returned (although the total number of hits is always returned as a number to aid with paging in clients). If <Start> is omitted, the default value used is 1 (i.e. the first record). If <!HowMany> is omitted, '''all''' records are returned. 
    222237 
    223  
    224 ==== Ordering: <!OrderBy> and <!OrderByDirection> ==== 
    225 Ordering of the result set can optionally be requested by providing an <!OrderBy> element containing one or more <!OrderByField>s, each with an optional associated <!OrderByDirection> (default : descending). Available fields for use as an <!OrderByField> are listed in the [#OrderByFieldsList OrderByFieldList]. 
    226238 
    227239==== Scope of search: <Scope> ==== 
    228240The optional <Scope> element can be used to restrict the search to onr or more of the supported NDG Data Provider Groups, defined in NDG controlled vocabulary http://vocab.ndg.nerc.ac.uk/list/N010/0. Currently supported values from this vocabulary are these are given in the the [#ScopeList ScopeList] list accessible via the getList operation. 
    229241If <Scope> is omitted, the search is not restricted in this way. 
    230  
    231 ==== Format ==== 
    232 The optional <Format> element can be used to restrict the search to records in the discovery index whose original (harvested) representation was in the format specified. The format must be one of the values listed in the [#metadataFormatList metadataFormatList] available from the getList operation. Default behaviour if this element is omitted is not to restrict the search in this way (and return results irrepsective of their harvested format). 
    233  
    234 ==== !RecordDetail ==== 
    235 The optional <!RecordDetail> element enables selection of the level of detail included in each result returned in the search result. Values must be one of those available from the [#RecordDetailList RecordDetailList]. Default is DocumentId, which simply returns the id of the document corresponding to the result. See [#SearchResults Search Results] section for further explanation of the structures returned in each of these cases. 
    236  
    237  
    238242==== Search Results ==== 
    239243The doSearchResponse message is defined in the WSDL as shown below (click image for larger version):