GET api/Media?systemName={systemName}&username={username}&password={password}&advertiserId={advertiserId}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all medias for advertiser

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

advertiserId

integer

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

includeClosed

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of APIMedia
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

AdvertiserId

Unique identifier of advertiser to which this belongs

integer

None.

ParentId

Unique identifier of media to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

CreationTimestamp

Timestamp when this was created

string

None.

StartTimestamp

Timestamp from whence this becomes active

string

None.

EndTimestamp

Timestamp until which this remains active

string

None.

ManuallyHalted

Denotes that this has been manually paused

boolean

None.

MimeType

Banners, Text (logo) and Bullet (logo): image/jpeg, image/jpg, image/gif, image/png, image/bmp Video: video/mp4, video/ogv, video/webm Flash: application/x-shockwave-flash

string

None.

FileName

Unique media file name

string

None.

VastProgram

Must be "2" indicating Vast 2

string

None.

ImageData

Image data

Collection of byte

None.

AltText

Alt text associated to image (Used for banner, text and bullet only)

string

None.

ThirdPartyURL

Third party URL from whence the browser should fetch the media

string

None.

ThirdPartyTag

Third party media tag

string

None.

X

Horizontal position in pixels (Used for vast overlays only)

integer

None.

Y

Vertical position in pixels (Used for vast overlays only)

integer

None.

Width

Width in pixels - Used for banner, text (logo), video, bullet (logo), vast, flash

integer

None.

Height

Height in pixels - Used for banner, text (logo), video, bullet (logo), vast, flash

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "advertiserId": 2,
    "parentId": 1,
    "state": "sample string 3",
    "creationTimestamp": "sample string 4",
    "startTimestamp": "sample string 5",
    "endTimestamp": "sample string 6",
    "manuallyHalted": true,
    "mimeType": "sample string 7",
    "fileName": "sample string 8",
    "vastProgram": "sample string 9",
    "imageData": "QEA=",
    "altText": "sample string 10",
    "thirdPartyURL": "sample string 11",
    "thirdPartyTag": "sample string 12",
    "x": 1,
    "y": 1,
    "width": 1,
    "height": 1
  },
  {
    "id": 1,
    "advertiserId": 2,
    "parentId": 1,
    "state": "sample string 3",
    "creationTimestamp": "sample string 4",
    "startTimestamp": "sample string 5",
    "endTimestamp": "sample string 6",
    "manuallyHalted": true,
    "mimeType": "sample string 7",
    "fileName": "sample string 8",
    "vastProgram": "sample string 9",
    "imageData": "QEA=",
    "altText": "sample string 10",
    "thirdPartyURL": "sample string 11",
    "thirdPartyTag": "sample string 12",
    "x": 1,
    "y": 1,
    "width": 1,
    "height": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIMedia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIMedia>
    <AdvertiserId>2</AdvertiserId>
    <AltText>sample string 10</AltText>
    <CreationTimestamp>sample string 4</CreationTimestamp>
    <EndTimestamp>sample string 6</EndTimestamp>
    <FileName>sample string 8</FileName>
    <Height>1</Height>
    <Id>1</Id>
    <ImageData>QEA=</ImageData>
    <ManuallyHalted>true</ManuallyHalted>
    <MimeType>sample string 7</MimeType>
    <ParentId>1</ParentId>
    <StartTimestamp>sample string 5</StartTimestamp>
    <State>sample string 3</State>
    <ThirdPartyTag>sample string 12</ThirdPartyTag>
    <ThirdPartyURL>sample string 11</ThirdPartyURL>
    <VastProgram>sample string 9</VastProgram>
    <Width>1</Width>
    <X>1</X>
    <Y>1</Y>
  </APIMedia>
  <APIMedia>
    <AdvertiserId>2</AdvertiserId>
    <AltText>sample string 10</AltText>
    <CreationTimestamp>sample string 4</CreationTimestamp>
    <EndTimestamp>sample string 6</EndTimestamp>
    <FileName>sample string 8</FileName>
    <Height>1</Height>
    <Id>1</Id>
    <ImageData>QEA=</ImageData>
    <ManuallyHalted>true</ManuallyHalted>
    <MimeType>sample string 7</MimeType>
    <ParentId>1</ParentId>
    <StartTimestamp>sample string 5</StartTimestamp>
    <State>sample string 3</State>
    <ThirdPartyTag>sample string 12</ThirdPartyTag>
    <ThirdPartyURL>sample string 11</ThirdPartyURL>
    <VastProgram>sample string 9</VastProgram>
    <Width>1</Width>
    <X>1</X>
    <Y>1</Y>
  </APIMedia>
</ArrayOfAPIMedia>