Version 8.3.8

Back | 

WsProgram

Retrieves all programs for a given project, or retrieves a single program. To retrieve all programs for a project, use the 'p' parameter. To retrieve a single program, use the 'v' parameter.

URL Format

/ws/ws_program/api/{app_token}/mode/json/apiv/5?p={project_uuid}&refid={project_refrenceId}&v={program_uuid}&prefid={program_refrenceId}&date_start={date_start}&date_end={date_end}&start={start}&end={end}&category_id={categoryID}&sortby={sortby}&sortdir={sortdir}&include_details={include_details}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
p string projectUuid of the project to retrieve programs for
start int Will return a subset of available programs. Used primarily for pagination. Default is set to 0
end integer Will return a subset of available programs. Used primarily for pagination. Default is set to start+20. Max length cannot exceed 50
category_id int The id of the category to search for, if working with a category project.
v string program uuid of the program
refid string project reference id
prefid string program reference id
date_start string start date filter. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC.
date_end string end date filter. Date must be in t/z format. Example 2013-05-07T06:17:55.827Z. All dates must be in UTC.
sortby string sort params . Possible values (sortnum, dateStart, dateEnd)
include_details string Include details param . Possible values (true,false). Show asset's metadatas.
psize int the page size for deep linking the programs (should be passed when uuid/v (program uuid) and p (project uuid ) is passed together Default is set to 1

Request Headers

Name

Possible Responses

  • 303 programs found
  • 881 No programs found
  • 316 Invalid Program UUID
  • 102 Invalid app token

Example Response

{
  "response": {
    "success": {
      "code": 303,
      "message": "Programs Found",
      "details": ""
    },
    "WsProgramResponse": {
      "program": [
        {
          "class": "Program",
          "sortnum": 2,
          "type": "video",
          "dateStart": "2013-06-05T13:43:00Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684449,
          "uuid": "v4794xh8",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "referenceId": "test123",
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1408554869\/5188329.jpg",
          "duration": "137.251998901367",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684449.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684449.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/x\/5\/4\/x54r8164_dhy4nn8y_h264_1328K.mp4,3400\/x\/5\/4\/x54r8164_rvuina90_h264_828K.mp4,3400\/x\/5\/4\/x54r8164_sy80g9bm_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684449",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_v4794xh8\/1684449.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_v4794xh8\/1684449.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "EPIC Trailer 2013 Movie - Official [HD]",
          "Description": "",
          "metadatas": {
            "adMngVASTPreroll": {
              "value": "test",
              "displayName": "VAST\/VPAID Pre-Roll Configuration URL"
            },
            "adMngVASTPostroll": {
              "value": "test",
              "displayName": "VAST\/VPAID Post-Roll Configuration URL"
            }
          },
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 3,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684451,
          "uuid": "y5pw2y72",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188313.jpg",
          "duration": "125.202003479004",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684451.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684451.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/r\/5\/7\/r57ahh75_i467hj5r_h264_1328K.mp4,3400\/r\/5\/7\/r57ahh75_v611j25q_h264_828K.mp4,3400\/r\/5\/7\/r57ahh75_ydsmj122_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684451",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_y5pw2y72\/1684451.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_y5pw2y72\/1684451.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Iron Man 3 Trailer 2012 - Official 2013 Movie [HD]",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 4,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684453,
          "uuid": "rkt6ds55",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188343.jpg",
          "duration": "150.904998779297",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684453.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684453.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/t\/e\/o\/teo0cyx2_q2tvuw9e_h264_1328K.mp4,3400\/t\/e\/o\/teo0cyx2_y76c8550_h264_828K.mp4,3400\/t\/e\/o\/teo0cyx2_a75a7773_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684453",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_rkt6ds55\/1684453.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_rkt6ds55\/1684453.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Jack the Giant Slayer Trailer 2013 Movie - Official [HD]",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 5,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684471,
          "uuid": "r6j237sf",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188371.jpg",
          "duration": "102.468002319336",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684471.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684471.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/r\/p\/3\/rp39273f_ew6y81z7_h264_1328K.mp4,3400\/r\/p\/3\/rp39273f_y5b7gvo7_h264_828K.mp4,3400\/r\/p\/3\/rp39273f_m693l4he_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684471",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_r6j237sf\/1684471.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_r6j237sf\/1684471.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Jet Li - The Sorcerer and the White Snake Trailer (2013)",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 6,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684485,
          "uuid": "t3ufow1z",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188437.jpg",
          "duration": "155.317001342773",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684485.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684485.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/q\/e\/d\/qed8zrd4_f23pt5v8_h264_1328K.mp4,3400\/q\/e\/d\/qed8zrd4_u8bcx4pn_h264_828K.mp4,3400\/q\/e\/d\/qed8zrd4_mc48945a_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684485",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_t3ufow1z\/1684485.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_t3ufow1z\/1684485.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Oblivion Trailer 2013 Tom Cruise Movie - Official [HD]",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 7,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684701,
          "uuid": "k9j8ufbn",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188539.jpg",
          "duration": "135.789993286133",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684701.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684701.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/o\/b\/u\/obuxrl9k_h7y02oty_h264_1328K.mp4,3400\/o\/b\/u\/obuxrl9k_oj16kka1_h264_828K.mp4,3400\/o\/b\/u\/obuxrl9k_a461sjf7_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684701",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_k9j8ufbn\/1684701.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_k9j8ufbn\/1684701.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "The Man With The Iron Fists Trailer 2012 Movie - Official [H",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 8,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684699,
          "uuid": "exqug478",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188553.jpg",
          "duration": "152.809997558594",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684699.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684699.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/s\/w\/5\/sw5kk473_ts1f5m01_h264_1328K.mp4,3400\/s\/w\/5\/sw5kk473_m6bsc887_h264_828K.mp4,3400\/s\/w\/5\/sw5kk473_gw1tb57q_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684699",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_exqug478\/1684699.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_exqug478\/1684699.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "The Lone Ranger Trailer #2 Johnny Depp 2013 Movie - Official",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 9,
          "type": "video",
          "dateStart": "2013-06-05T13:43:48Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684489,
          "uuid": "f7u94020",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188427.jpg",
          "duration": "117.330001831055",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684489.m3u8",
            "iphoneM3u8Url": null,
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/y\/1\/1\/y11e4mjl_p1s9bkgg_h264_1328K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684489",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_f7u94020\/1684489.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_f7u94020\/1684489.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Star Trek Into Darkness NEW Trailer 1 (2013) - JJ Abrams Mov",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 10,
          "type": "video",
          "dateStart": "2013-06-05T13:43:47Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684487,
          "uuid": "r8792sv8",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188447.jpg",
          "duration": "110.362998962402",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684487.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684487.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/t\/r\/y\/trye343o_y2j2eo9g_h264_1328K.mp4,3400\/t\/r\/y\/trye343o_j541d030_h264_828K.mp4,3400\/t\/r\/y\/trye343o_hav82040_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684487",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_r8792sv8\/1684487.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_r8792sv8\/1684487.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Oz the Great and Powerful Trailer 2013 Disney Movie - Offici",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        },
        {
          "class": "Program",
          "sortnum": 11,
          "type": "video",
          "dateStart": "2013-06-05T13:43:47Z",
          "dateEnd": "2025-06-05T00:00:00Z",
          "assetid": 1684475,
          "uuid": "b4y3j2h2",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/qa-ovp.piksel.tech\/thumbs\/tid\/w100\/h74\/t1372855594\/5188391.jpg",
          "duration": "150.139999389648",
          "projectUUID": "kith9ev8",
          "asset": {
            "ipadM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPad\/1684475.m3u8",
            "iphoneM3u8Url": "http:\/\/qa-ovp.piksel.tech\/ws\/get_m3u8\/v1\/iPhone\/1684475.m3u8",
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd.net\/i\/mm\/flvmedia\/,3400\/q\/g\/s\/qgs2xqi8_tk3qqwya_h264_1328K.mp4,3400\/q\/g\/s\/qgs2xqi8_h239mm4i_h264_828K.mp4,3400\/q\/g\/s\/qgs2xqi8_xbj091h5_h264_464K.mp4,.csmil\/master.m3u8?cid=3400&aid=1684475",
            "rtmpSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_kith9ev8\/tr_programuuid_b4y3j2h2\/1684475.smil",
            "hdSmil": "http:\/\/qa-ovp.piksel.tech\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_kith9ev8\/tr_programuuid_b4y3j2h2\/1684475.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "Man of Steel Trailer #2 Superman 2013 Movie - Official [HD]",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "UA-52881139-1"
        }
      ],
      "currentCount": 10,
      "totalCount": "10"
    }
  }
}