GET v1/vods

Retrieve All VODs

Request Information

Parameters

NameDescriptionAdditional information
statuses Filter results by status.

Define this parameter in the request URI.

show Filter results by Show.

Define this parameter in the request URI.

offset Start results at this index.

Define this parameter in the request URI.

page_size Number of results to return.

Define this parameter in the request URI.

location Filter results to specific Location.

Define this parameter in the request URI.

query Filter results by Show title.

Define this parameter in the request URI.

sort_order Order results ascending or descending by requested sort.

Define this parameter in the request URI.

include Comma seperated list of resources to sideload with results.

Define this parameter in the request URI.

sort Sort results by this property.

Define this parameter in the request URI.

since This attribute allows the selection to return records that were modified after this timestamp.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "meta": {
    "offset": 0,
    "pageSize": 50,
    "count": 1
  },
  "shows": [
    {
      "location": 1,
      "id": 1000,
      "ageRating": 0,
      "title": "Awesome Show - March - Don't air past April",
      "category": 2,
      "comments": "This show is really awesome.",
      "bugText": "Pre-Recorded",
      "cgExempt": false,
      "contentRating": 0,
      "crawlLength": 99,
      "crawlText": "You are now watcing the most awesome show.",
      "custom1": "Custom Field One",
      "custom2": "Custom Field Two",
      "custom3": "Custom Field Three",
      "custom4": null,
      "custom5": null,
      "custom6": null,
      "custom7": null,
      "custom8": null,
      "eventDate": "2017-08-18T23:59:00.6221161-05:00",
      "lastModified": "2017-08-18T23:59:00.6221161-05:00",
      "liveIpExempt": false,
      "localId": "trms-123",
      "podcastExempt": false,
      "producer": 1,
      "project": 1,
      "reels": [
        1
      ],
      "vods": [
        1
      ],
      "cgTitle": "My Awesome Show",
      "runCount": 0,
      "showThumbnailOriginal": null,
      "showThumbnails": null,
      "showFiles": null,
      "firstRuns": null
    }
  ],
  "vods": [
    {
      "id": 1,
      "quality": 1,
      "disabled": false,
      "fileName": "1000-my_awesome_show-Medium-v1.mp4",
      "embedCode": null,
      "nonReflectEmbedCode": null,
      "url": null,
      "webVtt": null,
      "localUrl": null,
      "show": 1000,
      "transactions": [
        1
      ],
      "stateChange": "2017-08-18T23:59:00.6221161-05:00",
      "stateProgress": 100.0,
      "vodConfiguration": 1,
      "chapters": [],
      "lastTransaction": 2,
      "views": 0
    }
  ],
  "reels": [
    {
      "id": 1,
      "media": 1,
      "chapter": 1,
      "title": 1,
      "length": 200,
      "cue": 0,
      "reelNumber": 1,
      "show": 1000,
      "digitalFiles": [
        9292
      ]
    }
  ],
  "medias": [
    {
      "id": 1,
      "creationDate": "2017-08-18T23:59:00.6221161-05:00",
      "dispositionDate": "2017-08-18T23:59:00.6221161-05:00",
      "disposition": 1,
      "format": 1,
      "location": 1,
      "mediaName": "Media for Show ID 1000 - Reel 1",
      "preAssignedDevice": 1,
      "preAssignedDeviceSlot": 1,
      "overrideAspectRatio": 1
    }
  ],
  "digitalFiles": [
    {
      "ambiguous": false,
      "aspectRatio": 2,
      "bitrate": 25000,
      "server": 23,
      "controlModuleSet": 99,
      "codec": "MPEG2_IBP",
      "created": "2017-08-18T23:59:00.6221161-05:00",
      "fileName": "1000-1-awesome-file.mpg",
      "fileSize": 232323,
      "frameCount": 2233,
      "frameRate": 29.97,
      "height": 720,
      "id": 9292,
      "isValid": true,
      "isDeprecated": false,
      "location": 1,
      "modified": "2017-08-18T23:59:00.6221161-05:00",
      "partial": false,
      "path": "E:\\1000-1-awesome-file.mpg",
      "problemDescription": "",
      "reelNumber": 1,
      "sampleRate": 48000,
      "show": 1000,
      "supportedFields": 1,
      "updatedDateTime": "2017-08-18T23:59:00.6221161-05:00",
      "vbiExists": false,
      "width": 480,
      "reel": 99,
      "thumbnails": []
    }
  ],
  "vodTransactions": [
    {
      "id": 1,
      "lastModified": "2017-08-18T23:59:00.6221161-05:00",
      "percentComplete": 100.0,
      "startTime": "2017-08-18T23:59:00.6221161-05:00",
      "transactionType": 1,
      "vod": 1
    }
  ]
}

application/xml, text/xml

Sample:
<Resources xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CablecastAPI.DTOs">
  <DigitalFiles>
    <DigitalFile>
      <Ambiguous>false</Ambiguous>
      <AspectRatio>2</AspectRatio>
      <Bitrate>25000</Bitrate>
      <Codec>MPEG2_IBP</Codec>
      <ControlModuleSet>99</ControlModuleSet>
      <Created>2017-08-18T23:59:00.6221161-05:00</Created>
      <FileName>1000-1-awesome-file.mpg</FileName>
      <FileSize>232323</FileSize>
      <FrameCount>2233</FrameCount>
      <FrameRate>29.97</FrameRate>
      <Height>720</Height>
      <Id>9292</Id>
      <IsDeprecated>false</IsDeprecated>
      <IsValid>true</IsValid>
      <Location>1</Location>
      <Modified>2017-08-18T23:59:00.6221161-05:00</Modified>
      <Partial>false</Partial>
      <Path>E:\1000-1-awesome-file.mpg</Path>
      <ProblemDescription></ProblemDescription>
      <Reel>99</Reel>
      <ReelNumber>1</ReelNumber>
      <SampleRate>48000</SampleRate>
      <Server>23</Server>
      <Show>1000</Show>
      <SupportedFields>1</SupportedFields>
      <Thumbnails xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
      <UpdatedDateTime>2017-08-18T23:59:00.6221161-05:00</UpdatedDateTime>
      <VbiExists>false</VbiExists>
      <Width>480</Width>
    </DigitalFile>
  </DigitalFiles>
  <Medias>
    <Media>
      <CreationDate>2017-08-18T23:59:00.6221161-05:00</CreationDate>
      <Disposition>1</Disposition>
      <DispositionDate>2017-08-18T23:59:00.6221161-05:00</DispositionDate>
      <Format>1</Format>
      <Id>1</Id>
      <Location>1</Location>
      <MediaName>Media for Show ID 1000 - Reel 1</MediaName>
      <OverrideAspectRatio>1</OverrideAspectRatio>
      <PreAssignedDevice>1</PreAssignedDevice>
      <PreAssignedDeviceSlot>1</PreAssignedDeviceSlot>
    </Media>
  </Medias>
  <Meta>
    <Count>1</Count>
    <Offset>0</Offset>
    <PageSize>50</PageSize>
  </Meta>
  <Reels>
    <Reel>
      <Chapter>1</Chapter>
      <Cue>0</Cue>
      <DigitalFiles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>9292</d4p1:int>
      </DigitalFiles>
      <Id>1</Id>
      <Length>200</Length>
      <Media>1</Media>
      <ReelNumber>1</ReelNumber>
      <Show>1000</Show>
      <Title>1</Title>
    </Reel>
  </Reels>
  <Shows>
    <Show>
      <AgeRating>0</AgeRating>
      <BugText>Pre-Recorded</BugText>
      <Category>2</Category>
      <CgExempt>false</CgExempt>
      <CgTitle>My Awesome Show</CgTitle>
      <Comments>This show is really awesome.</Comments>
      <ContentRating>0</ContentRating>
      <CrawlLength>99</CrawlLength>
      <CrawlText>You are now watcing the most awesome show.</CrawlText>
      <Custom1>Custom Field One</Custom1>
      <Custom2>Custom Field Two</Custom2>
      <Custom3>Custom Field Three</Custom3>
      <Custom4 i:nil="true" />
      <Custom5 i:nil="true" />
      <Custom6 i:nil="true" />
      <Custom7 i:nil="true" />
      <Custom8 i:nil="true" />
      <EventDate>2017-08-18T23:59:00.6221161-05:00</EventDate>
      <FirstRuns xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <Id>1000</Id>
      <LastModified>2017-08-18T23:59:00.6221161-05:00</LastModified>
      <LiveIpExempt>false</LiveIpExempt>
      <LocalId>trms-123</LocalId>
      <Location>1</Location>
      <PodcastExempt>false</PodcastExempt>
      <Producer>1</Producer>
      <Project>1</Project>
      <Reels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
      </Reels>
      <RunCount>0</RunCount>
      <ShowFiles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <ShowThumbnailOriginal i:nil="true" />
      <ShowThumbnails xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <Title>Awesome Show - March - Don't air past April</Title>
      <Vods xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
      </Vods>
    </Show>
  </Shows>
  <VodTransactions>
    <VodTransaction>
      <Id>1</Id>
      <LastModified>2017-08-18T23:59:00.6221161-05:00</LastModified>
      <PercentComplete>100</PercentComplete>
      <StartTime>2017-08-18T23:59:00.6221161-05:00</StartTime>
      <TransactionType>1</TransactionType>
      <Vod>1</Vod>
    </VodTransaction>
  </VodTransactions>
  <Vods>
    <Vod>
      <Chapters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
      <Disabled>false</Disabled>
      <EmbedCode i:nil="true" />
      <FileName>1000-my_awesome_show-Medium-v1.mp4</FileName>
      <Id>1</Id>
      <LastTransaction>2</LastTransaction>
      <LocalUrl i:nil="true" />
      <NonReflectEmbedCode i:nil="true" />
      <Quality>1</Quality>
      <Show>1000</Show>
      <StateChange>2017-08-18T23:59:00.6221161-05:00</StateChange>
      <StateProgress>100</StateProgress>
      <Transactions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
      </Transactions>
      <Url i:nil="true" />
      <Views>0</Views>
      <VodConfiguration>1</VodConfiguration>
      <WebVtt i:nil="true" />
    </Vod>
  </Vods>
</Resources>