Changes between Version 6 and Version 7 of DPWS_API_NOTES


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

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v6 v7  
    205205The return has the same structure as the return in the doNewUpdateProviderDetails operation: 
    206206 
    207 [[Image(getProviderDetailsReturn.png, 400px)]] 
     207[[Image(getProviderDetailsResponse.png, 400px)]] 
    208208 
    209209{{{ 
     
    236236=== !DoHarvest Operation === 
    237237 
    238 The !DoHarvest operation will simply initiate a metadata harvest for a provider using the unique provider ID assigned to that provider at the time of provider details entry into the DPWS database.  The !DoHarvestRequest requires the ProviderID and optionally any number of !EmailReportID from the provider email details.  Note that the !EmailReportID element must contain the associated unique ID for the recipient in the relevant Provider details. 
     238The !DoHarvest operation will simply initiate a metadata harvest for a provider using the unique provider ID assigned to that provider at the time of provider details entry into the DPWS database.  The !DoHarvestRequest requires the ProviderID and optionally any number of !EmailReportID from the provider email details.  Note that the !EmailReportID element must contain the associated unique ID for the recipient in the relevant Provider details.  In the sample below, 162 is the ID assigned to Ms Upsy Daisy.  If Monitor is set to true then that email will also be notified even if no EmailReportID element is supplied. 
     239 
     240[[Image(doHarvestRequest.png, 400px)]] 
     241{{{ 
     242<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     243    <SOAP-ENV:Header/> 
     244    <SOAP-ENV:Body> 
     245        <doHarvest xmlns="http://ejb.revitalization.services.ndg/"> 
     246            <request xmlns=""> 
     247                <EmailReportID xmlns="http://ejb.revitalization.services.ndg/">162</EmailReportID> 
     248                <ProviderID xmlns="http://ejb.revitalization.services.ndg/">101</ProviderID> 
     249            </request> 
     250        </doHarvest> 
     251    </SOAP-ENV:Body> 
     252</SOAP-ENV:Envelope> 
     253}}} 
    239254 
    240255The !DoHarvestResponse will return a status value and message as well as a unique process identifier in `processID`.  This assigned identifier is the value that must be used in subsequent !getProcessStatus and !DoIngest operations. 
     256 
     257[[Image(doHarvestReturn.png, 400px)]] 
     258 
     259In the response note that a unique process id is returned as an attribute "id" for processID.  This is the value that must be used in subsequent getStatusProcess and doIngest operations. 
     260 
     261{{{ 
     262<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> 
     263    <env:Header/> 
     264    <env:Body> 
     265        <ns1:doHarvestResponse xmlns:ns1="http://ejb.revitalization.services.ndg/"> 
     266            <return> 
     267                <ns1:Confirmation> 
     268                    <ns1:Status>OK</ns1:Status> 
     269                </ns1:Confirmation> 
     270                <ns1:processID ns1:id="430"/> 
     271            </return> 
     272        </ns1:doHarvestResponse> 
     273    </env:Body> 
     274</env:Envelope> 
     275}}} 
    241276 
    242277=== !DoIngest ===