Changes between Version 65 and Version 66 of Discovery/DiscoveryWebServiceMEDIN


Ignore:
Timestamp:
02/03/10 15:34:54 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Discovery/DiscoveryWebServiceMEDIN

    v65 v66  
    298298Similarly, if <!DocumentSummary> is specified as the recordDetail, a <!DocumentSummary> element is returned for each result, as outlined in the doSearchResponseMessage, above. In addition to the content added by the <!DocumentBrief> option, <!DocumentSummary> includes the metadata abstract, and temporal and spatial information. For the temporal and spatial components of this <!DocumentSummary> the schema reuses the structures used for the search request, hence the optional temporalOperator are spatialOperator elements are redundant (and will be omitted) from the return context, however the dateRangeTarget element is useful as a contextual reminder of what the returned date pertains to (temporal coverage of data, last revision date of data, or ingestion date of metadata, etc.). 
    299299 
    300 Correspondingly the <!DocumentFull> element builds upon the <!DocumentBrief> and <!DocumentSummary> elements adding further information (including <!AdditionalInformation>) but importantly a <Document> element contains a CDATA representation of the original XML metadata with format corresponding to that chosen in <!MetadataFormat> (defaulting to MEDIN_2.3).  These 4 document types comprise a data type "Documents" which is dependant on the values supplied in <!RetrieveCriteria> and is also reused in the !DoPresent operation. 
     300Correspondingly the <!DocumentFull> element builds upon the <!DocumentBrief> and <!DocumentSummary> elements adding further information (including <!AdditionalInformation>) but importantly a <Document> element contains a CDATA representation of the original XML metadata with format corresponding to that chosen in <!MetadataFormat> (defaulting to MEDIN_2.3).   
     301For information, it should be noted that documents harvested (via OAI-PMH) are, at the time of ingest, stored in their native format but additionally converted to static copies of each of the supported return formats (listed in the [#PresentFormatList PresentFormatList].) When a document is requested for presenation in a particular format, the static copy (either the native copy or the generated copy in the requested format) is returned from the database. 
     302 
     303These 4 document types comprise a data type "Documents" which is dependant on the values supplied in <!RetrieveCriteria> and is also reused in the !DoPresent operation. 
    301304 
    302305 
    303306=== !DoPresent operation === 
    304307 
    305 The doPresent operation provides a means of retrieving (presenting) one or more XML documents from the database. The doPresentRequest message is defined as follows (click image to enlarge): 
     308The !DoPresent operation provides a means of retrieving (presenting) one or more XML documents from the database.  The !DoPresent is distinguished from the !DoSearch in that is allows the specific request of documents according to ID with the !DoPresent response matching the order defined in the !DoPresent request.  The structure of the !DoPresent is closely related to that of the !DoSearch as most of the data types are reused. 
     309 
     310. The doPresentRequest message is defined as follows (click image to enlarge): 
    306311 
    307312[[Image(doPresentSchema.png, 400px)]] 
    308313 
    309 Within the <Documents> element, one or more <!DocumentId> elements should each contain the name of a document (in the form returned in the <!DocumentId> of the doSearchReturn message) to be retrieved. The optional <Format> element should be populated with one of the supported format names as listed by the PresentFormatList accessible via the [#getListoperation getList] operation. All documents returned by a single invocation of the doPresent operation are returned in the same format, i.e. the choice of presentFormat applies to the doPresent request and not individual documents. 
    310 For information, it should be noted that documents harvested (via OAI-PMH) are, at the time of ingest, stored in their native format but additionally converted to static copies of each of the supported return formats (listed in the [#PresentFormatList PresentFormatList].) When a document is requested for presenation in a particular format, the static copy (either the native copy or the generated copy in the requested format) is returned from the database. 
    311  
    312 ==== doPresent response ==== 
    313 The doPresentResponse message is defined in the WSDL as follows (click image to enlarge): 
     314Within the <Documents> element, one or more <!DocumentId> elements should each contain the name of a document (in the form returned in the <!DocumentId> of the !DoSearchReturn message) to be retrieved.  The <!RetrieveCriteria> element again governs the level of detail and the XML format returned in the subsequent !DocumentFull//Document element.  The optional <!OrderBy> element is ignored when <!RetrieveCriteria> is used in a !DoPresent request. All documents returned by a single invocation of the doPresent operation are returned in the same format, i.e. the choice of presentFormat applies to the doPresent request and not individual documents. If <!MetadataFormat> is not defined then format defaults to MEDIN_2.3. 
     315 
     316 
     317==== !DoPresent response ==== 
     318 
     319The !DoPresentResponse message is defined in the WSDL as follows (click image to enlarge): 
    314320 
    315321[[Image(doPresentReturnSchema.png, 400px)]]