Changes between Version 4 and Version 5 of DPWS_API_NOTES


Ignore:
Timestamp:
24/08/10 16:41:07 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v4 v5  
    8888This 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. 
    8989 
    90 Note 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. 
     90Note 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. 
    9191 
    9292[[Image(doUpdateNewProviderRequest.png, 400px)]] 
     
    9494Example request setting up a new provider: 
    9595{{{ 
    96  
    97 }}} 
     96<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     97    <SOAP-ENV:Header/> 
     98    <SOAP-ENV:Body> 
     99        <doNewUpdateProvider xmlns="http://ejb.revitalization.services.ndg/"> 
     100            <request xmlns=""> 
     101                <DoNewUpdateProvider xmlns="http://ejb.revitalization.services.ndg/"> 
     102                <OAIProvider> 
     103                <splitBySet>false</splitBySet> 
     104                <Format>dif</Format> 
     105                </OAIProvider> 
     106                    <ProviderCommon> 
     107                    <ProviderURL>http://badc.nerc.ac.uk/badc_oai/provider</ProviderURL> 
     108                        <ProviderName>badc</ProviderName> 
     109                        <ProviderContacts> 
     110                            <Email>igglepiggle@stfc.ac.uk</Email> 
     111                            <Name>Dr Iggle Piggle</Name> 
     112                        </ProviderContacts> 
     113                        <ProviderAdminEmail> 
     114                            <EmailContact> 
     115                                <Email>upsy@nightgarden.land</Email> 
     116                                <Name>Ms Upsy Daisy</Name> 
     117                            </EmailContact> 
     118                            <Monitor>True</Monitor> 
     119                        </ProviderAdminEmail> 
     120                    </ProviderCommon> 
     121                </DoNewUpdateProvider> 
     122            </request> 
     123        </doNewUpdateProvider> 
     124    </SOAP-ENV:Body> 
     125</SOAP-ENV:Envelope> 
     126}}} 
     127 
     128The response type is show below 
    98129 
    99130[[Image(doUpdateNewProviderResponse.png, 400px)]] 
     131 
     132{{{ 
     133<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> 
     134    <env:Header/> 
     135    <env:Body> 
     136        <ns1:doNewUpdateProviderResponse xmlns:ns1="http://ejb.revitalization.services.ndg/"> 
     137            <return> 
     138                <ns1:Confirmation> 
     139                    <ns1:Status>OK</ns1:Status> 
     140                </ns1:Confirmation> 
     141            </return> 
     142        </ns1:doNewUpdateProviderResponse> 
     143    </env:Body> 
     144</env:Envelope> 
     145}}} 
     146 
     147The response should return the provider ID assigned to this provider. 
     148 
     149In order to update details on an existing provider this operation should also be used, but the existing ProviderID element must be filled with the assigned ProviderID value.  Any values present in the request will be used to update the provider details i.e. : 
     150 
     151{{{ 
     152<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     153    <SOAP-ENV:Header/> 
     154    <SOAP-ENV:Body> 
     155        <doNewUpdateProvider xmlns="http://ejb.revitalization.services.ndg/"> 
     156            <request xmlns=""> 
     157                <DoNewUpdateProvider xmlns="http://ejb.revitalization.services.ndg/"> 
     158                <OAIProvider> 
     159                <splitBySet>false</splitBySet> 
     160                <Format>dif</Format> 
     161                </OAIProvider> 
     162                    <ProviderCommon> 
     163                    <ProviderURL>http://badc.nerc.ac.uk/badc_oai/provider</ProviderURL> 
     164                        <ProviderName>badc</ProviderName> 
     165                        <ProviderContacts> 
     166                            <Email>iscoobydoo@scary.net</Email> 
     167                            <Name>Scooby Doo</Name> 
     168                        </ProviderContacts> 
     169                        <ProviderAdminEmail> 
     170                            <EmailContact> 
     171                                <Email>upsy@nightgarden.land</Email> 
     172                                <Name>Ms Upsy Daisy</Name> 
     173                            </EmailContact> 
     174                            <Monitor>True</Monitor> 
     175                        </ProviderAdminEmail> 
     176                    </ProviderCommon> 
     177                    <ProviderID>110</ProviderID> 
     178                </DoNewUpdateProvider> 
     179            </request> 
     180        </doNewUpdateProvider> 
     181    </SOAP-ENV:Body> 
     182</SOAP-ENV:Envelope> 
     183}}} 
    100184 
    101185