Changes between Version 9 and Version 10 of DPWS_API_NOTES


Ignore:
Timestamp:
25/08/10 10:20:39 (9 years ago)
Author:
sdonegan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v9 v10  
    298298=== !DoIngest === 
    299299 
    300 A metadata ingest into the Discovery database for a particular provider is acheived by simply supplying the !ProcessID returned in the !DoHarvestResponse resulting from a previous !DoHarvestRequest for the specified provider.  Like the !DoHarvestRequest an !EmailReportID can be supplied to which process completion reporting messages can be sent if the user wishes. 
     300A metadata ingest into the Discovery database for a particular provider is acheived by simply supplying the !ProcessID returned in the !DoHarvestResponse resulting from a previous !DoHarvestRequest for the specified provider.  Like the !DoHarvestRequest an !EmailReportID can be supplied to which process completion reporting messages can be sent if the user wishes.  The doIngest operation must only be called on a processID once the getProcessStatus operation has verifed that the harvest has completed. 
     301 
     302[[Image(doIngestRequest.png, 400px)]] 
     303{{{ 
     304<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     305    <SOAP-ENV:Header/> 
     306    <SOAP-ENV:Body> 
     307        <doIngest xmlns="http://ejb.revitalization.services.ndg/"> 
     308            <request xmlns=""> 
     309                <ProcessID xmlns="http://ejb.revitalization.services.ndg/" 
     310                    xmlns:ns1="http://ejb.revitalization.services.ndg/" ns1:id="430"/> 
     311                <EmailReportID xmlns="http://ejb.revitalization.services.ndg/">196</EmailReportID> 
     312            </request> 
     313        </doIngest> 
     314    </SOAP-ENV:Body> 
     315</SOAP-ENV:Envelope> 
     316}}} 
     317 
     318Note that the processID to ingest is supplied as the value for attribute "id" in ProcessID. 
     319 
     320The response will be a simple confirmation that the ingest request has been recieved. 
     321 
     322[[Image(doIngestResponse.png, 400px)]] 
     323 
     324{{{ 
     325<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> 
     326    <env:Header/> 
     327    <env:Body> 
     328        <ns1:doIngestResponse xmlns:ns1="http://ejb.revitalization.services.ndg/"> 
     329            <return> 
     330                <ns1:Confirmation> 
     331                    <ns1:Status>OK</ns1:Status> 
     332                </ns1:Confirmation> 
     333            </return> 
     334        </ns1:doIngestResponse> 
     335    </env:Body> 
     336</env:Envelope> 
     337}}} 
    301338 
    302339=== !GetProcessStatus ===