Advertising API

Section: Files

This section performs operations against assets/files uploaded to the Advertising system

Available Resource List

Action Type Resource Description
File List http://api.dmds.com/api/v1/ad/files/{fileType} Resource for listing files based on fileType, dayRange, dateRange and searchFilter criteria
File Stream Link http://api.dmds.com/api/v1/ad/files/{fileType}/{fileID}/streamLink Resource for retrieving a streaming link for the specified fileID
File Download Link http://api.dmds.com/api/v1/ad/files/{fileType}/{fileID}/downloadLink/{downloadLinkType} Resource for retrieving a download link for the specified fileID
File States http://api.dmds.com/api/v1/ad/files/{fileType}/filestates Resource for retrieving a list of DMDS file states for the specified {fileType}


File List

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/files/{fileType}
  • QUERYSTRING: ?dayRange={dayRangeVal}&fromDateRange={fromDateRangeVal}&toDateRange={toDateRangeVal}&searchFilter={searchFilterVal}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
fileType One of:
  • all
  • audio
  • video
  • document
  • image
 A filter on asset/file type all, audio, video

Additional QUERYSTRING Filters (Optional)

Parameter Parameter Type Description Default Value Examples
dayRange Numeric Specifies number of days to filter file list from today's date 7 7, 10, 30
fromDateRange Date String Format (YYYYMMDD) Specifies from date range (YYYYMMDD), used in conjunction with toDateRange parameter. This parameter is ignored if dayRange is specified No default 20120101, 20111201
toDateRange Date String Format (YYYYMMDD) Specifies to date range (YYYYMMDD), used in conjunction with fromDateRange parameter. This parameter is ignored if dayRange is specified No default 20120101, 20111201
searchFilter String Specifies a keyword to filter file list results on Empty string test, mytestfile

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



File List

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/files/{fileType}/{fileID}/streamLink

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
fileType Only video is supported currently A filter on asset/file type video
fileID number Unique identifier for the file (video ID) 123456, 435121

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



File List

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/files/{fileType}/{fileID}/downloadLink/{downloadLinkType}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
fileType Only video is supported currently A filter on asset/file type video
fileID number Unique identifier for the file (video ID) 123456, 435121
downloadLinkType One of:
  • preview
  • broadcast
 The type of video file to download preview, broadcast

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



File States List

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/files/{fileType}/filestates

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
fileType One of:
  • audio
  • video
  • document
  • image
 A filter on asset/file type video

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema

API Reference