Podcast API

GET /podcast/list

List of available podcasts

Example request:

GET /podcast/list?id%5b%5d=103&id%5b%5d=99&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
Date: Wed, 22 May 2019 15:09:35 GMT
Server: Apache/2.4.18 (Ubuntu)
Access-control-allow-origin: *
Content-length: 959
Content-type: application/json; charset=utf-8

{
    "results":[
        {
            "id":"103",
            "title":"U.S. Army Alaska",
            "description":"A cornerstone of America's Army where Army values and mission-focused training coexist with the grandeur of life in Alaska to forge Ready Units, Strong families, and Arctic Tough Leaders.  USARAK is an experience of a lifetime.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/thumbs\/podcast\/images\/103\/122x92_q95.jpg"
        },
        {
            "id":"99",
            "title":"U.S. Army Bloggers Roundtable",
            "description":"The Army\u2019s Online and Social Media Division hosts Bloggers Roundtables - phone interviews that connect bloggers and online journalists to Senior Army Leaders and subject matter experts. Army Bloggers Roundtables focus on hot topics and exclusive opportunities for the online community such as smartphone technologies for Soldiers, uniform changes, physical training doctrine, and the drawdown in Iraq.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/thumbs\/podcast\/images\/99\/122x92_q95.jpg"
        }
    ]
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • id: Limit which podcasts are returned. Multiple ids can be be specified with the following syntax "&id[]=99&id=103"
  • prettyprint: [1] Spaces out JSON response in more readable format useful for debugging
  • thumb_width: [1-2000] Width of thumbnail in pixels. If thumb_height is provided, this defaults to the aspect ratio native width of the asset relative to the height requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_height: [1-2000] Height of thumbnail in pixels. If thumb_width is provided, this defaults to the aspect ratio native height of the asset relative to the width requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_quality: [1-100] Quality of generated thumbnail. Default is 95
  • sortdir: One of asc, desc.

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 podcast
  • title: Title of podcast
  • description: Description of podcast
  • thumbnail: Url to resized image of podcast logo as specified by thumb_XXX params

GET /podcast/get

Get podcast contents

Example request:

GET /podcast/get?id=103&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
Date: Wed, 22 May 2019 15:09:35 GMT
Server: Apache/2.4.18 (Ubuntu)
Access-control-allow-origin: *
Content-length: 1552
Content-type: application/json; charset=utf-8

{
    "page_info":{
        "total_results":15,
        "results_per_page":2
    },
    "results":[
        {
            "id":9533,
            "asset_id":"video:136010",
            "type":"video",
            "title":"Arctic Ice Bridge Operations",
            "short_description":"Alaska's 2nd Engineer Brigade, 6th Engineer Battalion...",
            "date_published":"2012-01-27T00:01:36-05:00",
            "keywords":"Alaska, USRAK, U.S. Army Alaska, Engineers, 6th Eng. Bn, 2nd Engineer Bde, Brehl Garza",
            "date":"2012-01-25T00:00:00-05:00",
            "category":"Package",
            "aspect_ratio":"16:9",
            "duration":103,
            "hd":true,
            "credit":"Brehl Garza",
            "country":"US",
            "state":"AK",
            "city":"Delta Junction",
            "unit_name":"United States Army Alaska",
            "branch":"Army",
            "timestamp":"2014-08-03T08:26:49-04:00",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/thumbs\/frames\/video\/1201\/136010\/122x92_q95.jpg",
            "url":"https:\/\/www.dvidshub.net\/video\/136010\/arctic-ice-bridge-operations"
        },
        {
            "id":9124,
            "asset_id":"video:129163",
            "type":"video",
            "title":"U.S. Army Alaska Command Video",
            "short_description":"U.S. Army Alaska executes continuous training and...",
            "date_published":"2011-11-02T13:38:38-04:00",
            "keywords":"USARAK, Alaska",
            "date":"2011-11-01T00:00:00-04:00",
            "category":"Package",
            "aspect_ratio":"16:9",
            "duration":470,
            "hd":true,
            "credit":"Brehl Garza",
            "country":"US",
            "state":"AK",
            "city":"Joint Base Elmendorf-Richardson",
            "unit_name":"United States Army Alaska",
            "branch":"Army",
            "timestamp":"2014-08-03T07:57:40-04:00",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/thumbs\/frames\/video\/1111\/129163\/122x92_q95.jpg",
            "url":"https:\/\/www.dvidshub.net\/video\/129163\/us-army-alaska-command-video"
        }
    ]
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • fields: Comma separated list of which fields to return
  • id: [int] Podcast id to retrieve contents for. Required.
  • max_results: [1-50] Maximum number of results to return per page. Default and maximum value are both 50.
  • page: [int] What page to load. Defaults to 1.
  • prettyprint: [int] Spaces out JSON response in more readable format useful for debugging
  • short_description_length: [1-300] Specify length of short_description up to 300 characters. Defaults to 60.
  • thumb_width: [1-2000] Width of thumbnail in pixels. If thumb_height is provided, this defaults to the aspect ratio native width of the asset relative to the height requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_height: [1-2000] Height of thumbnail in pixels. If thumb_width is provided, this defaults to the aspect ratio native height of the asset relative to the width requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_quality: [1-100] Quality of generated thumbnail. Default is 95

Notes: Thumbnails are created on first load. Subsequent request will use cache. Use on larger result sets will take longer to run the first time.


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:

  • asset_id: Asset id
  • branch: Name of branch that produced this asset
  • credit: Who created the asset
  • category: Category of the asset
  • city: City where the asset was created
  • country: Country where the asset was created
  • duration: [int] type=video|audio: Length of asset in seconds
  • keywords: Comma separated list of keywords
  • date: Date in ISO8601 format of when the asset was created
  • date_published: Date in ISO8601 format of when the asset was published at DVIDS
  • id: Podcast item id
  • short_description: Shortened version of asset's description. Adjusted via short_description_length param.
  • thumbnail: Url to resized image of asset as specified by thumb_XXX params
  • timestamp: Date in ISO8601 format of when the asset was last updated
  • title: Title of asset
  • type: Asset type
  • unit_name: Full name of unit credited with media asset.
  • url: Url to asset on dvidshub.net