Series API

GET /series/list

List of available series

Example 1 request:

GET /series/list?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 1 response:

HTTP/1.1 200 OK
Date: Tue, 16 Jul 2019 14:52:23 GMT
Server: Apache/2.4.18 (Ubuntu)
Access-control-allow-origin: *
Content-length: 5818
Content-type: application/json; charset=utf-8

{
    "results":[
        {
            "id":"12",
            "title":"Airforce Management Modules",
            "description":"Airforce Content and Site Management Modules",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/12.jpg"
        },
        {
            "id":"1",
            "title":"Armed Forces Boxing",
            "description":"The Pentagon Channel Sports takes you ringside.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/1.jpg"
        },
        {
            "id":"26",
            "title":"Armed with Science",
            "description":"Armed with Science is a dedicated channel aimed at sparking the conversation about the science, innovation and technology that is shaping the future of the force every day. Content is engaging, and in tandem with the Armed With Science Blog, encourages open discussion about the technological contributions the Department of Defense provides to the world of science.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/26.jpg"
        },
        {
            "id":"2",
            "title":"Battleground",
            "description":"Historic films from WWII, Korea, Vietnam & other conflicts.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/2.jpg"
        },
        {
            "id":"36",
            "title":"Boot Camp: Making a Sailor",
            "description":"Follow the story of four U.S. Navy recruits as they leave their hometowns and go through Navy Boot Camp at U.S. Navy Recruit Training Command.\r\n\r\nAll Hands Magazine and Recruit Training Command take you inside the Navy\u2019s only Boot Camp for an unfiltered look at what recruits endure in order to earn the title of U.S. Navy Sailor.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/36.jpg"
        },
        {
            "id":"11",
            "title":"Bragging Rights",
            "description":"Looks at various military training exercises and competitions.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/11.jpg"
        },
        {
            "id":"3",
            "title":"Close Combat",
            "description":"An 8-week series on military combatives training.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/3.jpg"
        },
        {
            "id":"4",
            "title":"Command Performance",
            "description":"Go backstage with top entertainers.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/4.jpg"
        },
        {
            "id":"15",
            "title":"Desert Vision",
            "description":"Features stories about Soldiers serving Third Army from Camp Arifjan in Kuwait. Produced by 20th Public Affairs Detachment - Kuwait.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/15.jpg"
        },
        {
            "id":"29",
            "title":"DOD News Now",
            "description":"Episodes of the DOD News production: DOD News Now",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/"
        },
        {
            "id":"32",
            "title":"DOD News: In Focus",
            "description":"Episodes of the DOD News production: DOD News: In Focus",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/"
        },
        {
            "id":"5",
            "title":"Fit for Duty",
            "description":"High-energy, 30-minute workouts led by service members.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/5.jpg"
        },
        {
            "id":"6",
            "title":"FNG",
            "description":"A survival guide for new service members.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/6.jpg"
        },
        {
            "id":"16",
            "title":"In The Fight",
            "description":"A monthly half hour show that offers an incomparable and rare insight of life on the frontlines reported directly by U.S. military service members deployed around the globe.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/16.jpg"
        },
        {
            "id":"17",
            "title":"MO Guard TV",
            "description":"\u201cMO Guard TV\u201d is a half-hour television program that showcases the efforts of Citizen-Soldiers, Airmen and Family members throughout the Show-Me State.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/17.jpg"
        },
        {
            "id":"7",
            "title":"Recon",
            "description":"An in-depth look at operations, military events and history.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/7.jpg"
        },
        {
            "id":"14",
            "title":"Soldier's Journal",
            "description":"Soldiers Journal is a monthly television news magazine that covers accurate and timely information about Soldier missions, training, operations and achievements of today's Army.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/14.jpg"
        },
        {
            "id":"35",
            "title":"test",
            "description":"test",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/35.jpg"
        },
        {
            "id":"20",
            "title":"The 4orce Minute",
            "description":"The same great service show you know and love!  Created for the quick, need to know, lifestyle. Get in, get your info, get out.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/20.jpg"
        },
        {
            "id":"8",
            "title":"The American Veteran",
            "description":"A video news magazine designed to inform veterans, their families and their communities about the services and benefits they have earned through their service to America.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/8.jpg"
        },
        {
            "id":"9",
            "title":"The Grill Sergeants",
            "description":"A cooking show with top military chefs.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/9.jpg"
        },
        {
            "id":"23",
            "title":"Through Their Eyes",
            "description":"A series that focuses on bringing the audience closer to unique Service members and Veterans who have achieved remarkable success. At the intersection of Service and Civilian life, Through Their Eyes highlights military service, past and present by showcasing the family and military experiences that became the foundation for their incredible achievement. You're not just seeing the story, you're living it, Through Their Eyes.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/23.jpg"
        },
        {
            "id":"10",
            "title":"Tour of Duty",
            "description":"Tour of Duty is a program that highlights military installations and what opportunities are available for service members stationed there. Available in High Definition.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/10.jpg"
        },
        {
            "id":"13",
            "title":"TPC News",
            "description":"From the Pentagon Channel NewsCenter \u2013 daily half-hour program featuring military news from top Defense officials and the Military Services from around the world.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/13.jpg"
        }
    ]
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • id: [int] Limit which series are returned. Multiple ids can be be specified with the following syntax "&id[]=16&id[]=9". When supplied, subseries are returned in response
  • prettyprint: [1] Spaces out JSON response in more readable format useful for debugging
  • 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 the series
  • title: Title of series
  • description: Description of series
  • subseries: [array] Returned if id param was passed. Contains id and title of subseries

Example 2 request:

GET /series/list?id%5b%5d=16&id%5b%5d=9&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 2 response:

HTTP/1.1 200 OK
Date: Tue, 16 Jul 2019 14:52:23 GMT
Server: Apache/2.4.18 (Ubuntu)
Access-control-allow-origin: *
Content-length: 976
Content-type: application/json; charset=utf-8

{
    "results":[
        {
            "id":"16",
            "title":"In The Fight",
            "description":"A monthly half hour show that offers an incomparable and rare insight of life on the frontlines reported directly by U.S. military service members deployed around the globe.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/16.jpg",
            "subseries":[
                {
                    "id":"73",
                    "title":"Subseries: 2007"
                },
                {
                    "id":"76",
                    "title":"Subseries: 2008"
                },
                {
                    "id":"79",
                    "title":"Subseries: 2009"
                },
                {
                    "id":"82",
                    "title":"Subseries: 2010"
                },
                {
                    "id":"85",
                    "title":"Subseries: 2011"
                },
                {
                    "id":"88",
                    "title":"Subseries: 2012"
                },
                {
                    "id":"91",
                    "title":"Subseries: 2013"
                },
                {
                    "id":"94",
                    "title":"Subseries: 2014"
                },
                {
                    "id":"105",
                    "title":"Subseries: 2015"
                },
                {
                    "id":"114",
                    "title":"Subseries: 2016"
                }
            ]
        },
        {
            "id":"9",
            "title":"The Grill Sergeants",
            "description":"A cooking show with top military chefs.",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/series\/9.jpg",
            "subseries":[
                {
                    "id":"31",
                    "title":"Season: One"
                },
                {
                    "id":"32",
                    "title":"Season: Two"
                },
                {
                    "id":"33",
                    "title":"Season: Three"
                }
            ]
        }
    ]
}

GET /series/episodes/list

Get series' episodes

Example request:

GET /series/episodes/list?id=9&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: Tue, 16 Jul 2019 14:52:23 GMT
Server: Apache/2.4.18 (Ubuntu)
Access-control-allow-origin: *
Content-length: 1732
Content-type: application/json; charset=utf-8

{
    "page_info":{
        "total_results":34,
        "results_per_page":2
    },
    "results":[
        {
            "id":"video:154444",
            "title":"The Grill Sergeants: Turkey Dinner",
            "date_published":"2007-12-10T12:00:00-05:00",
            "date":"2007-12-10T12:00:00-05:00",
            "category":"Series",
            "aspect_ratio":"16:9",
            "duration":1457,
            "keywords":"food, cooking, recipe, The Grill Sergeants",
            "rating":4,
            "country":"US",
            "unit_name":"Defense.gov",
            "branch":"Joint",
            "timestamp":"2018-09-28T10:04:25-04:00",
            "short_description":"On the menu: Roast Turkey, Dressing Ya Ya and Lumpless Gravy",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/thumbs\/frames\/video\/0712\/154444\/122x92_q95.jpg",
            "url":"https:\/\/www.dvidshub.net\/video\/154444\/grill-sergeants-turkey-dinner",
            "series_title":"The Grill Sergeants",
            "subseries_title":"Season: One",
            "subseries_id":31,
            "episode":1,
            "hls_url":"https:\/\/api.dvidshub.net\/hls\/video\/154444.m3u8?api_key=key-XXXXXXXXXXXXX",
            "unit_id":"66"
        },
        {
            "id":"video:154438",
            "title":"The Grill Sergeants: Comfort Foods",
            "date_published":"2007-12-17T12:00:00-05:00",
            "date":"2007-12-17T00:00:00-05:00",
            "category":"Series",
            "aspect_ratio":"16:9",
            "duration":1418,
            "keywords":"food, cooking, recipe, The Grill Sergeants",
            "country":"US",
            "unit_name":"Defense.gov",
            "branch":"Joint",
            "timestamp":"2018-09-28T10:04:25-04:00",
            "short_description":"On the menu: Corn Chowder, Grilled Cheese, Sweet Potato...",
            "thumbnail":"https:\/\/cdn.dvidshub.net\/media\/thumbs\/frames\/video\/0712\/154438\/122x92_q95.jpg",
            "url":"https:\/\/www.dvidshub.net\/video\/154438\/grill-sergeants-comfort-foods",
            "series_title":"The Grill Sergeants",
            "subseries_title":"Season: One",
            "subseries_id":31,
            "episode":2,
            "hls_url":"https:\/\/api.dvidshub.net\/hls\/video\/154438.m3u8?api_key=key-XXXXXXXXXXXXX",
            "unit_id":"66"
        }
    ]
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • id: [int] Series id to retrieve episodes for. Id or sub_id is required.
  • fields: Comma separated list of which fields to return
  • max_results: [1-50] Maximum number of results to return per page. Default and maximum value are both 50.
  • page: What page to load. Defaults to 1.
  • prettyprint: [1] Spaces out JSON response in more readable format useful for debugging
  • seriesless_title: [1] If set will try to remove the name of the series from the title
  • short_description_length: [1-300] Length of short_description reponse field
  • sort: One of episode, subseries_order.
  • sortdir: One of asc, desc.
  • sub_id: Subseries id to retrieve episodes for. Id or sub_id is required.
  • 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

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:

  • branch: One of Army, Navy, Air Force, Marines, Coast Guard, Joint
  • category: Category of the asset
  • country: Country where media was captured
  • 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
  • description: Description of the asset
  • id: Id of the asset
  • keywords: Comma separated list of keywords
  • rating: [float] Rating of the asset. Will not be returned if the asset has not been rated.
  • 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 the asset
  • unit_name: Full name of unit credited with media asset.
  • url: Url to asset on dvidshub.net