Changes between Version 21 and Version 22 of DPWS_API_NOTES


Ignore:
Timestamp:
25/08/10 11:57:10 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v21 v22  
    9595 
    9696 
    97 === !doNewUpdateProvider Operation === 
    98 This operation will update all information held for that particular provider ID with all information held in the request elements.  The operation will return a confirmation status and message.  Either the !CSWProvider or !OAIProvider elements must be provided depending on the type of metadata repository offered by the provider. 
     97=== doNewUpdateProvider Operation === 
     98This operation will update all information held for that particular provider ID with all information held in the request elements.  The operation will return a confirmation status and message.  Either the CSWProvider or OAIProvider elements must be provided depending on the type of metadata repository offered by the provider. 
    9999 
    100100Note that in the request do not enter values in ProviderID or in any of the email/ID elements - these are assigned by the DPWS and returned in other operations using the !ProviderDetail type.  The !ProviderContacts element is optional - use this for additional email contacts at the data provider.  In subsequent operations the email ID may be specified so the DPWS API can send emails to these contacts when harvest or ingest operations have completed.  The !ProviderAdminEmail element is mandatory and should be the email address of the main provider contact who has administrative control over this provider entry (and who should be the only provider user allowed to undertake this particular operation).  The monitor element should be set to True of the admin contact needs notifying of every operation, False if not. 
     
    215215 
    216216 
    217 === !GetProviderDetails Operation === 
    218  
    219 The getProviderDetails operation should be used to extract information on existing provider details in the DPWS database. The request simply requires the specification of the unique providerID assigned in the initial doNewUpdateProviderDetails operation: 
     217=== getProviderDetails Operation === 
     218 
     219The getProviderDetails operation should be used to extract information on existing provider details in the DPWS database.  This operation can be used to return information on ALL providers in the DPWS, or just a single provider.   
    220220 
    221221[[Image(getProviderDetailsRequest.png)]] 
     222 
     223This operation should be used in the first instance to extract providerIDs.  This can be done by calling the operation with NO !ProviderID element: 
     224{{{ 
     225<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     226    <SOAP-ENV:Header/> 
     227    <SOAP-ENV:Body> 
     228        <getProviderDetails xmlns="http://ejb.revitalization.services.ndg/"> 
     229            <request xmlns=""/> 
     230        </getProviderDetails> 
     231    </SOAP-ENV:Body> 
     232</SOAP-ENV:Envelope> 
     233}}} 
     234 
     235The DPP should call this operation first to extract and render information for all available data providers (including contact persons and related email addresses by ID - see below). 
     236 
     237To extract details on a specific provider the request simply requires the specification of the unique providerID assigned in the initial doNewUpdateProviderDetails operation: 
    222238 
    223239{{{