Version 7.9

Back | 

WsSearchPrograms

Searches one or more projects for programs matching the search string. The following fields are searched: asset metadata, program title, asset title, asset description, and program description.

URL Format

/ws/ws_search_programs/api/{app_token}/apiv/5/mode/json?p={project_uuid}&s={search_string}&sortBy={field}&sortDir={desc|asc}&start={start}&end={end}&field={field_name}

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.
project_uuid uuid project uuid found on the get code page.
s string search string to search on with length >= 3 characters, else nothing is returned. Base64 encode and urlencode the search string that will be used. For partial matching, the string needs to be ecapsulated with the "" character: search_string. For search strings that are longer then 1 word, each word needs to be wrapped with the "".
sortBy string default is by search weight, this can be overwritten with: programTitle, assetTitle, programCreation, assetCreation
sortDir string possible values: asc, desc
field string to search on, possible values: assetMetaValues, assetMetaNameValues, programTitle, assetTitle, assetDescription, programDescription
metaname string specific metaname to search within if assetMetaNameValues field is selected. This field needs to be base 64 encoded and then url encode.
start int starting index of the result set
end int end index of the result set

Possible Responses

  • 303 Project Programs Found
  • 338 Invalid Project UUID

Example Response

{
  "response": {
    "WsSearchProgramsResponse": {
      "0": {
        "class": "Category",
        "categoryid": 0,
        "totalCount": "2",
        "currentCount": "2"
      },
      "programs": [
        {
          "class": "Program",
          "sortnum": 2,
          "type": "video",
          "dateStart": "2012-08-24T12:51:08Z",
          "dateEnd": "2024-08-24T12:51:08Z",
          "assetid": 1028095,
          "uuid": "kksws76y",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "",
          "duration": "306.571990966797",
          "projectUUID": "iyy0mpo3",
          "asset": {
            "ipadM3u8Url": null,
            "iphoneM3u8Url": null,
            "rtmpSmil": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_iyy0mpo3\/tr_programuuid_kksws76y\/1028095.smil",
            "httpSmil": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_smilv2\/od\/http\/tr_projectuuid_iyy0mpo3\/tr_programuuid_kksws76y\/1028095.smil",
            "hdSmil": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_iyy0mpo3\/tr_programuuid_kksws76y\/1028095.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "QTP_Video-Large File",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "123"
        },
        {
          "class": "Program",
          "sortnum": 1,
          "type": "video",
          "dateStart": "2012-08-24T12:51:11Z",
          "dateEnd": "2024-08-24T12:51:11Z",
          "assetid": 1028096,
          "uuid": "d5975h4n",
          "presentationid": 0,
          "isHidden": 0,
          "geoFilterId": 0,
          "youtubePublishable": 1,
          "hasGeoFilter": false,
          "thumbnailUrl": "",
          "posterUrl": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/thumbs\/tid\/w100\/h74\/t1345812671\/3552290.jpg",
          "duration": "306.571990966797",
          "projectUUID": "iyy0mpo3",
          "asset": {
            "ipadM3u8Url": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_m3u8\/v1\/iPad\/1028096.m3u8",
            "iphoneM3u8Url": null,
            "m3u8AndroidURL": "http:\/\/hd23245-i.akamaihd-staging.net\/i\/mm\/flvmedia\/,73\/m\/8\/6\/m86q3752_i8do1nqd_h264_910K.mp4,.csmil\/master.m3u8?cid=73&aid=1028096",
            "rtmpSmil": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_smilv2\/od\/rtmp\/tr_projectuuid_iyy0mpo3\/tr_programuuid_d5975h4n\/1028096.smil",
            "httpSmil": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_smilv2\/od\/http\/tr_projectuuid_iyy0mpo3\/tr_programuuid_d5975h4n\/1028096.smil",
            "hdSmil": "http:\/\/ec2-174-129-101-142.compute-1.amazonaws.com\/ws\/get_smilv2\/od\/hd\/tr_projectuuid_iyy0mpo3\/tr_programuuid_d5975h4n\/1028096.smil",
            "captions": [
              
            ],
            "asset_type": "video"
          },
          "Title": "QTP_Video-Large File",
          "Description": "",
          "hasChapters": false,
          "vmapUrl": "",
          "googleAnalyticsAccount": "123"
        }
      ]
    },
    "success": {
      "code": 303,
      "message": "Programs Found",
      "details": 303
    }
  }
}