Versions Compared

Old Version 36

changes.mady.by.user Bojan Suzic

Saved on

compared with

New Version 37

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:

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

 

GET

/harvest

Return

Description:

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

HTTP method:

GET

.

-

startdate
{enddate}}
community
collection
idOnly=false
withdrawn=false

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.

json
xml

200, 204, 400, 500

Item status and retrieval

C

Verb

URL

Description

Mandatory parameters

Optional parameters

Sorting fields

Response Data

Formats

Response codes

 

GET

Name and description

Value and notes

Base URI:

/items/{id}

Description:

Returns Return detailed information about an item.

HTTP method: id

GET -

Required parameters:

{id}: item id

Sorting fields supported:

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

Response formats:

json, xml

Status codes

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


name
lastmodified
submitter

Response details

Contains an information about an item including resource name, metadata, owning collection, collections stored in, communities stored in, bundle ids, last modified date, archival/withdrawn status and submitter of an item

Name and description

Value and notes

.

json
xml

200, 204, 400, 500

 

GET Base URI:

/items/{id}/permissions

Description:

Returns Return status of user permissions on this item.

HTTP method:

GET

Required parameters:

{id}: item id

Response formats:

json, xml

Status codes

200: OK
400: bad request
500: internal server error

id

-

id
name
lastmodified
submitter

Response details

Boolean variable, stating can user edit the listed item

Name and description

Value and notes

.

json
xml

200, 400, 500

 

GET Base URI:

/items/{id}/communities?idOnly=false&immediateOnly=true

Description:

Return Returns communities this item is part of.

HTTP method: -

GET -

Required parameters:

Sorting fields supported:

id, name, countitems: community properties used for sorting

Response formats:

json, xml

Status codes

200: OK
400: bad request
500: internal server error

Response details

Communities listed

id
name
countitems

Communities listed.

json
xml

200, 400, 500

 

GET

Name and description

Value and notes

Base URI:

/items/{id}/collections?idOnly=false

Description:

Return Returns collections this item is part of.

HTTP method: -

GET -

Required parameters:

Sorting fields supported:

id, name, countitems: collection parameters

Response formats:

json, xml

Status codes

200: OK
400: bad request
500: internal server error

Response details

Collections listed

Name and description

Value and notes

id
name
countitems

Collections listed.

json
xml

200, 400, 500

 

GET

Base URI:

/bitstream/{id} Description:

Returns bitstream object - usually the library item file

HTTP method:

GET

Required parameters:

{id}: bitstream item id

Response formats:

json, xml (not yet complete)

Status codes

200: OK
404: Not found
400: bad request
401: Unauthorized
403: Forbidden
500: internal server error

.

id

-

-

Response details

Includes all information about referenced bitstream, including file name, licence, corresponding ittem etc. It is possible only to get information for particular bitstreams. When the request is made without parameters/references, the blank list is presented (there is no list of all bitstreams in the system available).

Name and description

Value and notes

json
xml

200, 400, 401, 403, 404, 500

 

GET Base URI:

/bitstream/{id}/receive Description:

Returns checksum of bitstream

HTTP method:

GET

Required parameters:

{id}: bitstreamitem id

Response formats:

binary

Status codes

200: OK
400: bad request
401: Unauthorized
403: Forbidden
500: internal server error

.id-

-

-

Checksum of bitstream.

json
xml

200, 400, 401, 403, 404, 500

Response details

Receive full bitstream


User oriented functions


Name and description

Value and notes

Base URI:

/users?query=query&idOnly=false

Description:

Returns list containing id, name and email of persons (optionally matching a query)

HTTP method:

GET

Optional parameters:

Sorting fields supported:

id, name, lastname, fullname, language: sorting properties of user(submitter) supported

Response formats:

json, xml

Status codes

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

Response details

List with information on particular user. Additionaly only identifiers are sent if idOnly is true.

...