-
Notifications
You must be signed in to change notification settings - Fork 0
API Endpoints and Controllers
Area list with collection counts.
Method: GET
Params: no parameters
Route: /rest/area/collections
Controller: listAreasWithCount
Retrieve list of areas.
Method: GET
Params: no parameters
Route: /rest/areas
Controller: list
Retrieve area by Id.
Method: GET
Params: id -- the area id
Route: /rest/area/byId/:id
Controller: byId
##Subjects##
Retrieve list of subjects in an area.
Method: GET
Params: id -- the area id
Route: /rest/subjects/byArea/:id
Controller: subjectsByArea
Retrieve the tags associated with a single collection.
Method: GET
Params: collid -- The collection ID.
Route: /rest/collection/tags/:collId
Controller: tagsForCollection
typesForCollection
Retrieves the types associated with a single collection.
Method: GET
Params: collid -- The collection ID.
Route: /rest/collection/types/:collId
allCollections
Retrieves a list of all collections.
Method: GET
Route: /rest/collections/all
collectionById
Retrieves single collection information.
Params: id -- The collection ID.
Method: GET
Route: /rest/collection/info/byId/:id
collectionsByArea
Retrieves list of collections by area ID.
Params: id -- The area ID.
Method: GET
Route: /rest/collection/byArea/:id
collectionsBySubject
Retrieves a list of collections by subject and area IDs.
Params: areaId -- The area ID.
id -- The subject ID.
Method: GET
Route: /rest/collection/bySubject/:id/area/:areaId
allCollectionsByCategory
Retrieves a list of collections by category.
Params: id -- The category ID.
Method: GET
Route: /rest/collection/byCategory/:id
allCollectionsBySubject
Retrieves collections by subject (from all areas)
Params: id -- The subject ID.
Method: GET
Route: /rest/collection/bySubject/:id
subjectsByArea
Retrieves a list of subjects by area.
Params: id -- The area ID.
Method: GET
Route: /rest/subjects/byArea/:id
browseList (deprecated)
Returns a JSON list of objects retrieved from the eXist database host.
Params: collection -- The collection name.
Method: GET
Route: /rest/getBrowseList/:collection