Versions Compared

Old Version 33

changes.mady.by.user Bojan Suzic

Saved on

compared with

New Version 34

changes.mady.by.user Bojan Suzic

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

C

Verb

URL

Description

Mandatory parameters

Optional parameters

Sorting fields

Response Data

Formats

Response codes

 

GET

/search

Return a list of all objects found by searching criteria.
Notice: community and collection are mutually exclusive options.

-

TBD modifiers{{query=query}}&(community=id or
\\{{collection=id}}
{{idOnly=false}}

id
name
lastmodified
submitter

Item info with basic metadata for the search results. Additionally return only
identifiers when idOnly=true is used.

json
xml

200, 204, 400, 500

Name and description

Value and notes

Base URI:

/search?query=query&(community=id!collection=id)&idOnly=false

Description:

Returns a list of all objects found by searching criteria

HTTP method:

GET

Optional parameters:

query: string query for searching, without query method behaves like
browsing with additional sorting/ordering capabilities
community=id: the id of community limiting search to
collection=id: the id of collection limiting search to
Notice: community and collection are mutually exclusive options
idOnly=false: using true returns only identifiers of the results

Sorting fields supported:

id, name, lastmodified, submitter: sorting by id, name, last modifed date or submitter of item

Sorting/ordering modifiers:

title, issueDate, author, subject, submitter

Response formats:

json, xml

Status codes

200: OK
204: no content
400: bad request
500: internal server error

Response details

Item info with basic metadata for the search results. Additionally return only
identifiers when idOnly=true is used.


Name and description

Value and notes

Base URI:

/harvest?startdate=startdate&enddate=enddate?(community=id!collection=id)&idOnly=false&withdrawn=false

Description:

Returns a list of all objects that have been created, modified or withdrawn within specified time range

HTTP method:

GET

Optional parameters:

startdate: start date
enddate: end date
date is defined with ISO 8601 format, e.g. YYYY-MM-DD or 2009-08-
20T21:15Z; if the date parameters are ommited, then
from_beginning/to_current_time are assumed
community=id: the id of community limiting search to
collection=id: the id of collection limiting search to
Notice: community and collection are mutually exclusive options
idOnly=false: using true returns only identifiers of the results
withdrawn=false: with true includes withdrawn items too

Sorting/ordering modifiers:

id, name, lastmodified, submitter: information on item returned

Response formats:

json, xml

Status codes

200: OK
204: no content
400: bad request
500: internal server error

Response details

Contains item info including id, name, handle, metadata, bitstreams according to
the defined requirements. Additionally when idOnly=true only identifiers of
results are returned. If the date is in incompatible format, error 400 is returned.

...