media_list_ratecards {civis}

List all ratecards

Description

List all ratecards

Usage

media_list_ratecards(archived = NULL, filename = NULL, dma_number = NULL)

Arguments

archived

string optional. The archival status of the requested item(s).

filename

string optional. If specified, will be used to filter the ratecards returned. Substring matching is supported with "%" and "*" wildcards (e.g., "filename=%ratecard%" will return both "ratecard 1" and "my ratecard").

dma_number

integer optional. If specified, will be used to filter the ratecards by DMA.

Value

An array containing the following fields:

id

integer, The ratecard ID.

filename

string, Name of the ratecard file.

startOn

string, First day to which the ratecard applies.

endOn

string, Last day to which the ratecard applies.

dmaNumber

integer, Number of the DMA associated with the ratecard.

archived

string, The archival status of the requested item(s).