Changes between Version 20 and Version 21 of DPWS_API_NOTES


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

--

Legend:

Unmodified
Added
Removed
Modified
  • DPWS_API_NOTES

    v20 v21  
    138138The response type is show below 
    139139 
    140 [[Image(doUpdateNewProviderResponse.png, 400px)]] 
     140[[Image(doUpdateNewProviderResponse.png)]] 
    141141 
    142142{{{ 
     
    219219The 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: 
    220220 
    221 [[Image(getProviderDetailsRequest.png, 400px)]] 
     221[[Image(getProviderDetailsRequest.png)]] 
    222222 
    223223{{{ 
     
    236236The return has the same structure as the return in the doNewUpdateProviderDetails operation: 
    237237 
    238 [[Image(getProviderDetailsResponse.png, 400px)]] 
     238[[Image(getProviderDetailsResponse.png)]] 
    239239 
    240240{{{ 
     
    269269The !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. 
    270270 
    271 [[Image(doHarvestRequest.png, 400px)]] 
     271[[Image(doHarvestRequest.png)]] 
    272272{{{ 
    273273<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     
    286286The !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. 
    287287 
    288 [[Image(doHarvestResponse.png, 400px)]] 
     288[[Image(doHarvestResponse.png)]] 
    289289 
    290290In 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. 
     
    310310A 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. 
    311311 
    312 [[Image(doIngestRequest.png, 400px)]] 
     312[[Image(doIngestRequest.png)]] 
    313313{{{ 
    314314<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
     
    330330The response will be a simple confirmation that the ingest request has been recieved. 
    331331 
    332 [[Image(doIngestResponse.png, 400px)]] 
     332[[Image(doIngestResponse.png)]] 
    333333 
    334334{{{ 
     
    351351The system of metadata harvesting and ingestion can take long periods to complete, especially when large numbers of records are involved and there is heavy traffic on the hardware systems employed at CEDA.  As the metadata harvest needs to fully complete before ingestion takes place the GetStatusProcess operations allow the client to determine when it is possible to continue with further operations on a specific processID.  This includes GetHarvestHistory and GetIngestHistory operations. 
    352352 
    353 [[Image(getStatusProcessRequest.png, 400px)]] 
     353[[Image(getStatusProcessRequest.png)]] 
    354354 
    355355The GetProcessStatusRequest requires simple the processID as input and the GetProcessStatusResponse will return 
     
    368368}}} 
    369369 
    370 [[Image(getStatusProcessResponse.png, 400px)]] 
     370[[Image(getStatusProcessResponse.png)]] 
    371371 
    372372{{{ 
     
    393393The DPP should perform the GetHarvestHistory operation once a GetStatus has affirmed the processID completion.  The DPP should use this operation to either download and synchronise the local sqlLite db contents or render the information directly on the DPP front end.  When this operation is called with a providerID it will return just the history for that provider.  If no providerID is supplied in the request the response will return the harvest history for all providers.  A date range is optional - if this is not supplied then all harvest history records are returned. 
    394394 
    395 [[Image(getHarvestHistoryRequest.png, 400px)]] 
     395[[Image(getHarvestHistoryRequest.png)]] 
    396396 
    397397{{{ 
     
    408408}}} 
    409409 
    410 [[Image(getHarvestHistoryRequest.png, 400px)]] 
     410[[Image(getHarvestHistoryRequest.png)]] 
    411411 
    412412{{{ 
     
    465465 
    466466 
    467 [[Image(getIngestHistoryRequest.png, 400px)]] 
     467[[Image(getIngestHistoryRequest.png)]] 
    468468 
    469469{{{ 
     
    481481 
    482482 
    483 [[Image(getIngestHistoryResponse.png, 400px)]] 
     483[[Image(getIngestHistoryResponse.png)]] 
    484484 
    485485{{{