API Collections - uclibs/ucrate GitHub Wiki
Calls
| Method | URL (https://scholar.uc.edu) | Description |
|---|---|---|
| GET | /api/collections/id(.json) |
Return a collection. |
| PATCH | /api/collections/id(.json) |
Update a collection. |
| POST | /api/collections | Create a collection. |
The id field is only if you have an existing id, you can't make your own.
Fields
| Field | Required | Multi-valued | Notes |
|---|---|---|---|
| For creating | no | Needed in case the uploader doesn't have an account | |
| first_name | For creating | no | Needed in case the uploader doesn't have an account |
| last_name | For creating | no | Needed in case the uploader doesn't have an account |
| access | no | no | Must be either public, registered, or "" for private (defaults to private) |
| title | For creating | no | |
| creator | For creating | no | |
| description | For creating | no | |
| creator | For creating | yes | |
| license | For creating | no | Must be a license in config/authorities/licenses.yml |
Multi-Valued Fields
Multi-valued fields are fields that allow for multiple values in them. When using the website, there is a button that allows you to add another field. In the API, all you have to do is put a | between them. For example "related_url": "www.google.com|www.bing.com".