GET v1/media

Retrieve all Media.

Request Information

Parameters

NameDescriptionAdditional information
media_name Search term to filter Media Name

Define this parameter in the request URI.

creation_date Filter Media by creation date using "creation_date_operator"

Define this parameter in the request URI.

creation_date_operator Operator to compare create_date parameter. Valid Values: '=' '<' '<=' '>' '>='

Define this parameter in the request URI.

disposition_date Filter Media by Disposition date using the "disposition_date_operator"

Define this parameter in the request URI.

disposition_date_operator Operator to compare disposition_date parameter. Valid Values: '=' '<' '<=' '>' '>='

Define this parameter in the request URI.

ids Restrict Media to specific IDs

Define this parameter in the request URI.

disposition Filter Media by specific disposition.

Define this parameter in the request URI.

offset Return results starting at this record.

Define this parameter in the request URI.

page_size Number of results to return.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "media": [
    {
      "id": 1,
      "creationDate": "2017-09-20T10:34:20.5603938-05:00",
      "dispositionDate": "2017-09-20T10:34:20.5603938-05:00",
      "disposition": 1,
      "format": 1,
      "location": 1,
      "mediaName": "sample string 2",
      "preAssignedDevice": 1,
      "preAssignedDeviceSlot": 1,
      "overrideAspectRatio": 1
    },
    {
      "id": 1,
      "creationDate": "2017-09-20T10:34:20.5603938-05:00",
      "dispositionDate": "2017-09-20T10:34:20.5603938-05:00",
      "disposition": 1,
      "format": 1,
      "location": 1,
      "mediaName": "sample string 2",
      "preAssignedDevice": 1,
      "preAssignedDeviceSlot": 1,
      "overrideAspectRatio": 1
    },
    {
      "id": 1,
      "creationDate": "2017-09-20T10:34:20.5603938-05:00",
      "dispositionDate": "2017-09-20T10:34:20.5603938-05:00",
      "disposition": 1,
      "format": 1,
      "location": 1,
      "mediaName": "sample string 2",
      "preAssignedDevice": 1,
      "preAssignedDeviceSlot": 1,
      "overrideAspectRatio": 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">
  <Media>
    <Media>
      <CreationDate>2017-09-20T10:34:20.5603938-05:00</CreationDate>
      <Disposition>1</Disposition>
      <DispositionDate>2017-09-20T10:34:20.5603938-05:00</DispositionDate>
      <Format>1</Format>
      <Id>1</Id>
      <Location>1</Location>
      <MediaName>sample string 2</MediaName>
      <OverrideAspectRatio>1</OverrideAspectRatio>
      <PreAssignedDevice>1</PreAssignedDevice>
      <PreAssignedDeviceSlot>1</PreAssignedDeviceSlot>
    </Media>
    <Media>
      <CreationDate>2017-09-20T10:34:20.5603938-05:00</CreationDate>
      <Disposition>1</Disposition>
      <DispositionDate>2017-09-20T10:34:20.5603938-05:00</DispositionDate>
      <Format>1</Format>
      <Id>1</Id>
      <Location>1</Location>
      <MediaName>sample string 2</MediaName>
      <OverrideAspectRatio>1</OverrideAspectRatio>
      <PreAssignedDevice>1</PreAssignedDevice>
      <PreAssignedDeviceSlot>1</PreAssignedDeviceSlot>
    </Media>
    <Media>
      <CreationDate>2017-09-20T10:34:20.5603938-05:00</CreationDate>
      <Disposition>1</Disposition>
      <DispositionDate>2017-09-20T10:34:20.5603938-05:00</DispositionDate>
      <Format>1</Format>
      <Id>1</Id>
      <Location>1</Location>
      <MediaName>sample string 2</MediaName>
      <OverrideAspectRatio>1</OverrideAspectRatio>
      <PreAssignedDevice>1</PreAssignedDevice>
      <PreAssignedDeviceSlot>1</PreAssignedDeviceSlot>
    </Media>
  </Media>
</Resources>