-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
112e5bc
commit bb25e8a
Showing
2 changed files
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
********************** | ||
Retrieve List via ID | ||
********************** | ||
|
||
Endpoint to retrieve information about all talks collected together in a Public List | ||
|
||
All the responses conform to the `HAL specification <http://stateless.co/hal_specification.html>`_. | ||
|
||
|
||
.. http:get:: /collections/id/(string:id) | ||
Retrieve list by unique slug identifier, including all talks | ||
|
||
**Example request**: | ||
|
||
.. sourcecode:: http | ||
|
||
GET api/collections/id/f6e6d9e6-d166-47d9-a894-35bc2f4a4580 | ||
Host: talks.ox.ac.uk | ||
Accept: application/json | ||
|
||
**Example response** | ||
|
||
.. sourcecode:: http | ||
|
||
HTTP/1.1 200 OK | ||
Content-Type: application/json | ||
|
||
{ | ||
"_embedded": { | ||
"talks": [ | ||
{ | ||
"_links": { | ||
"self": { | ||
"href": "/api/talks/52360e07-9b8b-477d-8bc7-8a25995e5ef8" | ||
}, | ||
"talks_page": { | ||
"href": "/talks/id/52360e07-9b8b-477d-8bc7-8a25995e5ef8/" | ||
} | ||
}, | ||
"description": "", | ||
"end": "2015-10-06T10:45:00Z", | ||
"formatted_date": "6 October 2015, 11:00", | ||
"formatted_time": "11:00", | ||
"location_details": "Seminar room", | ||
"location_summary": "Weatherall Institute of Molecular Medicine (WIMM), Seminar room, Headington OX3 9DS", | ||
"organiser_email": "liz.rose@imm.ox.ac.uk", | ||
"series": { | ||
"slug": "f204e37e-640e-4e1a-a3ef-dfb48c45630a", | ||
"title": "WIMM Occasional Seminars" | ||
}, | ||
"slug": "52360e07-9b8b-477d-8bc7-8a25995e5ef8", | ||
"start": "2015-10-06T10:00:00Z", | ||
"title_display": "Ameliorating \u03b2-thalassaemia by manipulating expression of the \u03b1-globin gene" | ||
} | ||
] | ||
}, | ||
"_links": { | ||
"talks_page": { | ||
"href": "/user/lists/id/f6e6d9e6-d166-47d9-a894-35bc2f4a4580/" | ||
} | ||
}, | ||
"description": "Talks about Athena Swan", | ||
"title": "Athena Swan Talks" | ||
} | ||
|
||
:param id: The unique slug identifier for the list | ||
:type id: string | ||
|
||
:statuscode 200: List found | ||
:statuscode 404: List not found | ||
:statuscode 503: Service not available |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
Editor Responsibilities | ||
======================= | ||
|
||
Please be aware that your talks will be advertised quite widely in the University. | ||
|
||
They may, for instance, be included in weekly digests and be added to people's calendars. For this reason, please be sure to **keep your talk information up-to-date**. | ||
|
||
Accurate | ||
-------- | ||
|
||
Imagine how annoying it can be to cycle halfway across Oxford only to find that a talk has been rescheduled or the location has changed. | ||
|
||
* Remember to :doc:`update Oxford Talks when a talk's details change <last-minute-changes>`. | ||
* When advertising a talk that isn't organized by you, remember to check the details regularly and, in the notes, tell the user where the most up-to-date information can be found. | ||
|
||
Complete | ||
-------- | ||
|
||
Very few people will make the effort to attend a seminar if they don't know the title or the speaker. | ||
|
||
* Use the TBA option for titles and speakers so that people can 'save the date', but please remember to go back and change the details later. | ||
|
||
Easy to find | ||
------------ | ||
|
||
Bear in mind that users of Oxford Talks may well look for talks by typing keywords or topics into the search box, or by browsing by department or topic. | ||
|
||
* Give your series and lists sensible titles | ||
* Add :doc:`an abstract or short description <formatting-the-abstract>`, if you have it available | ||
* Assign your talks to :doc:`topics <publicizing-your-talk>` - it shouldn't take long and even a very generic term can be helpful |