CWRC Entity Handler
https:/cwrc/basic-solr-config/blob/cwrc-entities/islandora_transforms/CWRC_Entities_to_solr.xslt
islandora_workflow
islandora/cwrc_entities/oa/HasTarget/{uri encoded}
For paging of results - unsupported as of 2014-10-06
islandora/cwrc_entities/oa/HasTarget/{uri encoded}?page.start={}&page.rows={}
GET
Accept: application/json
| Name | Description |
|---|---|
| page.start | (optional) For paging of results - the results page |
| page.rows | (optional) For paging of results - the number of rows per page |
| Name | Description |
|---|---|
| hasTarget | The query 'hasTarget' uri |
| numFound | The number of results in the 'oa_items' array |
| page.start | (optional) For paging of results - the results page of the current 'oa_items' |
| page.rows | (optional) For paging of results - the number of rows per page |
| oa_items | The number of results identified by the 'hasTarget' uri |
{
"hasTarget": "islandora:b305fc90-a59e-415e-8c58-f7ee5d06ad2f",
"numFound": "0",
"page": {
"start": "0",
"rows": "5"
},
"oa_items": [{},{},...]
}islandora/cwrc_entities/oa/mintURI
GET
Accept: application/json
None
| Name | Description |
|---|---|
| uri | OA minted annotation |
{"uri","http:\/\/id.cwrc.ca\/cwrc:2755fb77-b11a-43b8-947c-43654b1cb6d6"}islandora/cwrc_entities/oa/annotation
POST
Accept: application/json
| Name | Description |
|---|---|
| URI | The identifier for the annotation |
| hasTarget | hasTarget URI for the annotation |
| annotation | RDF XML serialiazation of the annotation |
Returns the same response as a GET Annotation request.
islandora/cwrc_entities/oa/annotation/{URI}
PUT
Accept: application/json
| Name | Description |
|---|---|
| annotation | RDF XML serialiazation of the annotation |
Returns the same response as a GET Annotation request.
islandora/cwrc_entities/oa/annotation/{URI}
GET
Accept: application/json
none
Returns the same response as a GET Annotation request.
islandora/cwrc_entities/oa/annotation/{URI}
DELETE
Accept: application/json
none
Returns the same response as a GET Annotation request.
{type} = person|organization|place|title
islandora/cwrc_entities/v1/search/{type}?
GET
Accept: application/json
| Name | Description |
|---|---|
| query | full-text query terms |
| limit | results per page |
| page | page number of results to retrieve |
Returns a JSON formated Solr result
islandora/cwrc_entities/v1/{type}/{PID}
POST
Accept: application/json
| Name | Description |
|---|---|
| data | XML entity object as per the CWRC schema - http://cwrc.ca/schemas/entities.rng |
{"pid":"namespace:UUID"}
islandora/cwrc_entities/v1/{type}/{PID}
PUT
Accept: application/json
| Name | Description |
|---|---|
| annotation | RDF XML serialiazation of the annotation |
{"pid":"namespace:UUID"}
islandora/cwrc_entities/v1/{type}/{PID}
GET
Accept: application/json
none
xml
islandora/cwrc_entities/v1/{type}/{PID}
DELETE
Accept: application/json
none
Unless otherwise specified each end-point can return the following responses.
In general 401 means an anonymous user attempted some action and was denied. Either the action is not granted to anonymous uses in the Drupal permissions, or XACML denied the action for the anonymous user.
In general 403 means an authenticated user attempted some action and was denied. Either the authenticated user does not have a Drupal role that grants him/her permission to perform that action, or XACML denied the action for that user.
In general a 404 will occur, when a user tries to perform an action on a object or datastream that doesn't not exist. Or XACML is hiding that object or datastream from the user.
404 Responses can be returned even if the user was not determined to have permission to perform the requested action, as the resource must be first fetched from fedora before the users permission can be determined.
| Name | Description |
|---|---|
| message | A detail description of the error. |
Any problem can trigger a 500 error, but in general you'll find that this is typically an error returned by Fedora.