Changes between Version 42 and Version 43 of Discovery/DiscoveryWebServiceMEDIN


Ignore:
Timestamp:
03/12/09 21:38:42 (10 years ago)
Author:
mpritcha
Comment:

Changed capitalisation

Legend:

Unmodified
Added
Removed
Modified
  • Discovery/DiscoveryWebServiceMEDIN

    v42 v43  
    3737The discovery web service relies on several lists of valid terms which are specific to the functionality of this service. The reason for using these 2 "helper" operations rather than encoding these valid terms as <xs:enumeration> in the schema part of the WSDL, is so that future modifications to the service need not necessarily require the modification of the WSDL (which can be incovenient for clients already developed around a particular release of the WSDL). The getListNames operation simply returns the names of these lists, which can then be used in a subsequent call to the getList operation. 
    3838 
    39 The WSDL document defines the getListNamesRequest message as an empty <getListNames> element, so the request message should look like this (omitting the SOAP Envelope & Body parent elements): 
    40 {{{ 
    41 <m:getListNames xmlns:m="urn:DiscoveryServiceAPI"/> 
    42 }}} 
    43 The getListNamesResponse message comprises a <getListNamesReturn> element, with child elements containing the names of the lists available for inspection: 
    44 {{{ 
    45 <getListNamesReturn xmlns="urn:DiscoveryServiceAPI"> 
    46         <listNames> 
    47                 <listName>presentFormatList</listName> 
    48                 <listName>orderByFieldList</listName> 
    49                 <listName>scopeList</listName> 
    50                 <listName>spatialOperatorList</listName> 
    51  
    52                 <listName>termTargetList</listName> 
    53                 <listName>spatialReferenceSystemList</listName> 
    54                 <listName>dateRangeTargetList</listName> 
    55                 <listName>temporalOperatorList</listName> 
    56                 <listName>metadataFormatList</listName> 
    57                 <listName>recordDetailList</listName>  
    58         </listNames> 
    59 </getListNamesReturn> 
     39The WSDL document defines the getListNamesRequest message as an empty <GetListNames> element, so the request message should look like this (omitting the SOAP Envelope & Body parent elements): 
     40{{{ 
     41<m:GetListNames xmlns:m="urn:DiscoveryServiceAPI"/> 
     42}}} 
     43The getListNamesResponse message comprises a <GetListNamesReturn> element, with child elements containing the names of the lists available for inspection: 
     44{{{ 
     45<GetListNamesReturn xmlns="urn:DiscoveryServiceAPI"> 
     46        <ListNames> 
     47                <ListName>PresentFormatList</ListName> 
     48                <ListName>OrderByFieldList</ListName> 
     49                <ListName>ScopeList</ListName> 
     50                <ListName>SpatialOperatorList</ListName> 
     51 
     52                <ListName>TermTargetList</ListName> 
     53                <ListName>SpatialReferenceSystemList</ListName> 
     54                <ListName>DateRangeTargetList</ListName> 
     55                <ListName>TemporalOperatorList</ListName> 
     56                <ListName>MetadataFormatList</ListName> 
     57                <ListName>RecordDetailList</ListName>  
     58        </ListNames> 
     59</GetListNamesReturn> 
    6060}}} 
    6161 
    6262=== getList operation === 
    6363 
    64 The contents of each of the lists named by the getListNames operation are accessible by invoking a call to the getList operation, with the name of the list as the single argument, encoded as a getListRequest message, as defined in the WSDL : 
     64The contents of each of the lists named by the getListNames operation are accessible by invoking a call to the getList operation, with the name of the list as the single argument, encoded as a GetListRequest message, as defined in the WSDL : 
    6565 
    6666Request: 
    6767{{{ 
    68 <getList xmlns="urn:DiscoveryServiceAPI"> 
    69     <listName>presentFormatList</listName> 
    70 </getList> 
     68<GetList xmlns="urn:DiscoveryServiceAPI"> 
     69    <ListName>PresentFormatList</ListName> 
     70</GetList> 
    7171}}} 
    7272 
    7373Response: 
    7474{{{ 
    75 <getListReturn xmlns="urn:DiscoveryServiceAPI"> 
    76     <list name="presentFormatList"> 
    77         <listMember>DC</listMember> 
    78         <listMember>DIF_v9.4</listMember> 
    79         <listMember>MEDIN_v2.3</listMember> 
    80      </list> 
    81 </getListReturn> 
    82 }}} 
    83 An explanation of the presentFormatList list is given later, in the context of the doPresent operation.  
     75<GetListReturn xmlns="urn:DiscoveryServiceAPI"> 
     76    <List name="presentFormatList"> 
     77        <ListMember>DC</ListMember> 
     78        <ListMember>DIF_v9.4</ListMember> 
     79        <ListMember>MEDIN_v2.3</ListMember> 
     80    </List> 
     81</GetListReturn> 
     82}}} 
     83An explanation of the PresentFormatList list is given later, in the context of the doPresent operation.  
    8484 
    8585=== doSearch operation ===