Version 7.7.3

Back | 


Returns a list of programs within a specific project. The project can be either a category project or a normal project. In either case, a category element will be returned to wrap the requested programs. If the project is non-category, then certain information will be blank, such as category id, category name, etc... If the project is a category project, a category id should be specified. If the category id is not specified, the results will be pulled from the first category found. Note: the default category may not contain any programs, and thus will return an empty set. Results can be paginated by using the start and end params together. Though not necessary, most requests should utilize these params as load time and the resulting stream size will be greatly reduced. This service is meant to replace GetProgramsByCategory.

URL Format

/ws/get_programs/api/{app_token}/p/{project_uuid}/catid/{category_id}/start/{start}/end/{end}/psize/{page size}/pr/{program uuid}/include_details/{true/false}/r/{referenceId}/c/{clientuuid}


Name Req Type Description
project_uuid uuid The uuid of the project to search
app_token string The user api token
referenceId string The referenceId for the project to search (clientuuid parameter required as well)
clientuuid string The client uuid (for use with referenceId parameter)
category_id int The id of the category to search for, if working with a category project.
pr string The program uuid of the program to search for in a given category or playlist/single project, if working with a category project the program must be present in a given category.
psize int the page size for deep linking the programs (should be passed when pr(program uuid is passed)) Default is set to 10
start int The start range of Programs to return. Must be used in conjunction with end. Zero-based index
end int The end range of Programs to return. Used in conjunctions with
include_details string The flag to return asset and assetfile details. start. Will return a subset of available programs. Used primarily for pagination. Zero-based inclusive index: E.G. /start/0/end/4/ will return five programs from the beginning. Start and End params are ignored for deep linking
mode string A flag signaling return type for the service. Defaults to XML. Can be {'xml', 'json'}
sortby string The column to sort by. Can be {title, date, sortnum}
sortdir string The sort direction. Can be {asc, desc}

Possible Responses

  • 303 Programs Found
  • 318 Invalid Category ID
  • 102 Invalid app token
  • 659 Invalid Client

Example Response

<?xml version="1.0" encoding="utf-8"?>
<response xmlns:xsi="" xmlns="" xmlns:ms="" xsi:schemaLocation="">
        <message>Programs Found</message>
        <dtstamp>2018-12-15 09:32:01</dtstamp>
            <program id="635015">
                <date_start>2012-04-30 17:39:48</date_start>
                <date_end>2024-04-30 17:39:48</date_end>
                    <metadata metaname="Title" display_name="Title">Baboons</metadata>
                    <metadata metaname="Description" display_name="Description"/>