Changes between Version 24 and Version 25 of Discovery/DiscoveryWebServiceMEDIN


Ignore:
Timestamp:
09/11/09 12:15:33 (10 years ago)
Author:
mpritcha
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Discovery/DiscoveryWebServiceMEDIN

    v24 v25  
    235235The 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). 
    236236 
    237 === RecordDetail === 
     237=== !RecordDetail === 
    238238The 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 recordList]. 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. 
    239239 
     
    260260Content below here not updated yet 
    261261---- 
    262 A typical search result was shown in the "Quick Start" section. A result where no hits were returned is shown below 
     262A result where no hits were returned is shown below: 
    263263{{{ 
    264264<doSearchReturn xmlns="urn:DiscoveryServiceAPI"> 
     
    269269</doSearchReturn> 
    270270}}} 
     271 
     272A result where 2 hits were returned, with the recordDetail set to documentId, is shown below: 
     273{{{ 
     274<doSearchReturn xmlns="urn:DiscoveryServiceAPI"> 
     275        <status>true</status> 
     276        <statusMessage>Search was successful.</statusMessage> 
     277        <resultId>0</resultId> 
     278        <hits>2</hits> 
     279        <documents> 
     280          <documentId>id of matching document, result 1]</documentId> 
     281          <documentId>[id of matching document, result 2]</documentId> 
     282        </documents> 
     283</doSearchReturn> 
     284}}} 
     285 
     286If <documentBrief> is specified as the recordDetail, a structure similar to that shown below is returned for each record in place of the <documentId> element shown above (click image to enlarge): 
     287 
    271288 
    272289=== doPresent operation ===