Snippets API

GET /snippets

List of extenal (non-dvidshub) live events

Example request:

GET /snippets?max_results=2&api_key=key-XXXXXXXXXXXXX HTTP/1.1
Host: api.dvidshub.net
Accept-encoding: gzip, deflate
Accept: application/json, text/javascript
Referer: https://api.dvidshub.net

Example response:

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 2
Server: Apache
Access-control-allow-origin: *
Expires: Thu, 29 Jul 2021 16:01:44 GMT
Cache-control: max-age=0, no-cache, no-store
Pragma: no-cache
Date: Thu, 29 Jul 2021 16:01:44 GMT
Connection: keep-alive
Set-cookie: PHPSESSID=3e21c2e17ac0929b4065be71c3f5eb75; path=/; domain=.dvidshub.net; secure; HttpOnly

[

]

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • from_date: Specify a date/time in ISO8601 format to return events newer than from_date
  • max_results: [1-50] Maximum number of results to return per page. Default and maximum value are both 50.
  • sort: One of begin, end
  • sortdir: One of asc, desc
  • to_date: Specify a date/time in ISO8601 format to return events older than to_date

Status Codes:

  • 200: no error
  • 400: invalid parameter(s) specified. See errors element in response for details.
  • 403: api_key not provided, invalid, or accessed from origin (protocol+domain) other than the one associated with the key provided.

Response Fields:

  • id: Id of the live event
  • begin: Date/time event starts in ISO8601 format
  • description: Event description
  • embed: HTML embed code for event
  • end: Date/time event ends in ISO8601 format
  • thumbnail: [array] Resized image of event poster as specified by thumb_XXX params
  • title: Event title

GET /snippets/{id}

Get additional details about external event

Example request:

GET /snippets/5?api_key=key-XXXXXXXXXXXXX HTTP/1.1
Host: api.dvidshub.net
Accept-encoding: gzip, deflate
Accept: application/json, text/javascript
Referer: https://api.dvidshub.net

Example response:

HTTP/1.1 400 Bad Request
Content-type: application/json
Content-length: 75
Server: Apache
Access-control-allow-origin: *
Expires: Thu, 29 Jul 2021 16:01:44 GMT
Cache-control: max-age=0, no-cache, no-store
Pragma: no-cache
Date: Thu, 29 Jul 2021 16:01:44 GMT
Connection: keep-alive
Set-cookie: PHPSESSID=3289fbc583640f25c0d23699f60d6999; path=/; domain=.dvidshub.net; secure; HttpOnly

{
    "error":0,
    "message":"Dvids_Model_Snippet with params (id => 5) not found"
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • id: [int] Id of of the live event

Status Codes:

  • 200: no error
  • 400: invalid parameter(s) specified. See errors element in response for details.
  • 403: api_key not provided, invalid, or accessed from origin (protocol+domain) other than the one associated with the key provided.

Response Fields:

  • id: Id of the live event
  • begin: Date/time event starts in ISO8601 format
  • description: Event description
  • embed: HTML embed code for event
  • end: Date/time event ends in ISO8601 format
  • thumbnail: [array] Resized image of event poster as specified by thumb_XXX params
  • title: Event title