Zelestra

Zelestra Standards

harvest

The harvest operation performs initiates an OAI-PMH harvest session to a specified metadata repository.

Request

The harvest operation requires a message that consists of a single HarvestRequest element.

Examples

URL Encoded:
uri=http://www.zelestra.com/oai&from=2010-05-15T12:01:00Z

XML:
<HarvestRequest>
  <URI>http://www.zelestra.com/oai</URI>
  <From>2010-05-15T12:01:00Z</From>
</HarvestRequest>

The HarvestRequest element MUST contain a URI element, which is the URI to an OAI-PMH metadata repository.

The HarvestRequest element MAY contain an all element, which when set to true, causes a complete harvest of all available records.

The HarvestRequest element MAY contain a metadataPrefix element, which designates what metadata format to request. If not included, then rdf is assumed.

The HarvestRequest element MAY contain a set element, which designates a specific set to harvest. Set designations use the standard OAI set spec format.

The HarvestRequest element MAY contain a from element, which designates that only metadata that has changed since the specified date is to be returned. If not included, then only metadata that has changed since the previous successful harvest from the metadata repository specified by the URI element is returned.

The HarvestRequest element MAY contain an until element, which designates that only metadata that has changed before the specified date is to be returned. The from and until elements may be used together to request a particular time period.

The HarvestRequest element MAY contain a verbose, when set to true causes more detailed reporting to be returned.

Operation

The specified metadata repository is harvested.

Response

The harvest operation returns an HTML formatted page which are the results of the harvest.

Faults

The harvest operation may return a badRequest fault if any of the request parameters are invalid.

The harvest operation may return a forbidden fault if the requestor does not have the appropriate permission.

The harvest operation may return an unauthorized fault if the requestor has not previously authenticated.

The harvest operation may return an operationFailed fault if the service was unable to otherwise fulfill the request.