WOMD.AccountExec
Returns a list of Account Executives
Input Parameters
Example Request:
{
"RequestType":"WOMD.AccountExec",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ACCOUNT_EXEC_ID | Account Exec ID | uniqueidentifier | GUID |
FIRST_NAME | Account Exec’s first name | varchar(50) | Any string value |
LAST_NAME | Account Exec’s last name | varchar(50) | Any string value |
PRINT_ABBREVIATION | Account Exec’s code in WO Traffic | varchar(5) | Any string value |
ROW_STATE | Specifies if Account Exec has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of record | smalldatetime | Valid date/time value |
UPDATE_DATE | Update Date of record | smalldatetime | Valid date/time value |
AE_GROUP_INT | Foreign Key of the Account Exec group | int | Join to WOMD.Lookups |
USERNAME | Account Exec’s WideOrbit login | varchar(50) | Any string value |
WOMD.Addresses
Returns a list of Addresses
Input Parameters
Example Request:
{
"RequestType":"WOMD.Addresses",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ADDRESS_ID | Address ID | uniqueidentifier | GUID |
ADDRESS_INT | Address ID, integer value | int | Any integer value |
ADDRESS_CITY | Address City | varchar(100) | Any string value |
ADDRESS_COUNTRY | Address Country | varchar(100) | Any string value |
ADDRESS_LINE1 | Address Line 1 | varchar(100) | Any string value |
ADDRESS_LINE2 | Address Line 2 | varchar(100) | Any string value |
ADDRESS_LINE3 | Address Line 3 | varchar(100) | Any string value |
ADDRESS_NAME | Address Name | varchar(100) | Any string value |
ADDRESS_STATE | Address State | varchar(25) | Any string value |
ADDRESS_ZIPCODE | Address Zip Code | varchar(50) | Any string value |
ROW_STATE | Specifies if Address has been deleted or not | int | 0, 1, or 2. |
CREATE_DATE | Create Date of Address record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created Address | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of Address | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated Address | varchar(250) | Any string value |
UPDATE_COUNT | Number of times Address has been Updated | int | Any integer value |
WOMD.AdvertiserBrands
Returns Advertiser Brands
Input Parameters
Example Request:
{
"RequestType":"WOMD.AdvertiserBrands",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ADVERTISER_BRAND_ID | Advertiser Brand ID | uniqueidentifier | GUID |
BRAND_NAME | Brand Name | varchar(50) | Any string value |
BRAND_DESCR | Brand Description | varchar(250) | Any string value |
BRAND_SEPARATION | Brand Separation (in milliseconds) | int | Any integer value |
ROW_STATE | Specifies if EC name has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Advertiser Brand record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Advertiser Brand | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.AdvECNames
Returns advertiser’s EC Name list
Input Parameters
Example Request:
{
"RequestType":"WOMD.AdvECNames",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ADVERTISER_ID | Advertiser ID | uniqueidentifier | GUID |
ECNAME | Advertiser’s EC Name | varchar(250) | Any string value |
SOURCE_SYSTEM | Source system where EC Name is used | varchar(250) | Any string value |
ROW_STATE | Specifies if EC name has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
UPDATE_DATE | Update Date of record | smalldatetime | Valid date/time value |
WOMD.Advertisers
Returns list of advertisers
Input Parameters
Example Request:
{
"RequestType":"WOMD.Advertisers",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ADVERTISER_ID | Advertiser ID | uniqueidentifier | GUID |
ADVERTISER_NAME | Advertiser’s Name | varchar(50) | Any string value |
NEW_BUSINESS_EXPIRE | Any revenue prior to this date is new business. | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ADVERTISER_REPORTING_NAME | Advertiser’s Reporting Name | varchar(100) | Any string value |
TCODE | Advertiser’s external ID | varchar(50) | Any string value |
REVENUE_PRODUCT_CODE_ID | Foreign key of the Product Code used for reporting revenue | uniqueidentifier | GUID, Join to WOMD.ProductCodes |
ADVERTISER_TYPE_INT | Foreign key of the Advertiser Type (optional) | int | Join to WOMD.Lookups |
ADDRESS_LINE1 | Advertiser’s address line 1 | varchar(100) | Any string value |
ADDRESS_LINE2 | Advertiser’s address line 2 | varchar(100) | Any string value |
ADDRESS_LINE3 | Advertiser’s address line 3 | varchar(100) | Any string value |
ADDRESS_CITY | Advertiser’s address city | varchar(100) | Any string value |
ADDRESS_STATE | Advertiser’s address state | varchar(25) | Any string value |
ADDRESS_ZIPCODE | Advertiser’s address zip code | varchar(50) | Any string value |
ADDRESS_COUNTRY | Advertiser’s country | varchar(100) | Any string value |
ROW_STATE | Specifies if Advertiser has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Advertiser’s Create Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Advertiser’s last Update Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.Agencies
Returns list of agencies
Input Parameters
Example Request:
{
"RequestType":"WOMD.Agencies",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
AGENCY_ID | Agency ID | uniqueidentifier | GUID |
AGENCY_NAME | Agency’s Name | varchar(50) | Any string value |
TCODE | Agency’s external ID | varchar(50) | Any string value |
ADDRESS_ZIPCODE | Agency’s address zip code | varchar(50) | Any string value |
ADDRESS_LINE1 | Agency’s address line 1 | varchar(100) | Any string value |
ADDRESS_LINE2 | Agency’s address line 2 | varchar(100) | Any string value |
ADDRESS_CITY | Agency’s address city | varchar(100) | Any string value |
ADDRESS_STATE | Agency’s address state | varchar(25) | Any string value |
MAIN_PHONE_NUMBER | Agency’s main phone number | varchar(50) | Any string value |
MAIN_FAX_NUMBER | Agency’s main fax number | varchar(50) | Any string value |
AGENCY_REPORTING_NAME | Agency’s Reporting Name | varchar(100) | Any string value |
AGENCY_TYPE_INT | Foreign key of the Agency Type (optional) | int | Join to WOMD.Lookups |
ORIGINAL_AGENCY_NAME | Agency’s Name | varchar(50) | Any string value |
DEFAULT_CASH_COMMISSION | Default Commission percentage for cash orders | float | Floating point numeric |
ROW_STATE | Specifies if Agency has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Agency’s Create Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Agency’s last Update Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.AgencyAdvertiser
Returns list of agencies and the advertisers they represent
Input Parameters
Example Request:
{
"RequestType":"WOMD.AgencyAdvertiser",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ADVERTISER_AGENCY_ID | Agency/Advertiser relationship ID | uniqueidentifier | GUID |
ADVERTISER_ID | Foreign key of Advertiser ID | uniqueidentifier | GUID, Join to WOMD.Advertisers |
AGENCY_ID | Foreign key of Agency ID | uniqueidentifier | GUID, Join to WOMD.Agencies |
ROW_STATE | Specifies if Agency has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Agency/Advertiser relationship Create Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Agency/Advertiser relationship last Update Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
BILLING_ADDRESS_INT | Foreign key for Billing Address | int | Join to WO_ADDRESSES |
REMIT_ADDRESS_INT | Foreign key for Remit Address | int | Join to WO_ADDRESSES |
CONTRACT_ADDRESS_INT | Foreign key for Contract Address | int | Join to WO_ADDRESSES |
WEB_BILLING_ADDRESS_INT | Foreign key for Web Billing Address | int | Join to WO_ADDRESSES |
WOMD.Calendars
Returns start and end dates of Broadcast calendar, Gregorian calendar, and custom calendars
Input Parameters
Example Request:
{
"RequestType":"WOMD.Calendars",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
CALENDAR_MONTH_ID | Calendar Month ID | uniqueidentifier | GUID |
CALENDAR_INT | Foreign key for Calendar Type (e.g., Broadcast, Calendar) | int | Join to WOMD.Lookups |
MONTH_NUMBER | Month number (e.g., 1 = January, 2 = February, etc.) | int | Integer value betweem 1 amd 12 |
QUARTER_NUMBER | Quarter number | int | Integer value betweem 1 amd 4 |
YEAR_NUMBER | Year number | int | Any integer value |
DISPLAY_NAME | Month name and year number | varchar(50) | Any string value |
MONTH_START_DATE | Month start date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
MONTH_END_DATE | Month end date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ROW_STATE | Specifies if Calendar Month has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Calendar Month Create Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Calendar Month last Update Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.Channels
Returns list of Channels
Input Parameters
Example Request:
{
"RequestType":"WOMD.Channels",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters": []
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
CHANNEL_ID | Channel ID | uniqueidentifier | GUID |
CHANNEL_INT | Channel ID, integer value | int | Any integer value |
STATION_ID | Foreign key of the Station that Channel belongs to | uniqueidentifier | GUID, Join to WOMD.Stations |
CHANNEL_NAME | Channel Name | varchar(5) | Any string value |
CHANNEL_REVENUE_WEIGHT | Revenue weight of channel | int | Any integer value |
ACTIVE_LOG_LENGTH | How far in the future new logs are created | int | Any integer value |
ROW_STATE | Specifies if Calendar Month has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
FIRST_LOG_DATE | First log date of Channel | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
LAST_LOG_DATE | Last log date of Channel | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FIRST_FINALIZED_LOG_DATE | First finalized log date of Channel | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
LAST_FINALIZED_LOG_DATE | Last finalized log date of Channel | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Channel last Update Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.InventoryCodes
Returns list of Inventory Codes
Input Parameters
Example Request:
{
"RequestType":"WOMD.InventoryCodes",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
INVENTORY_CODE_ID | Inventory Code ID | uniqueidentifier | GUID |
INVENTORY_CODE_NAME | Inventory Code Name | varchar(50) | Any string value |
INVENTORY_CODE_INT | Inventory Code ID, integer value | int | Any integer value |
INVENTORY_CODE_EXTERNAL_ID | External ID of the Inventory Code | varchar(50) | Any string value |
PARENT_INVENTORY_CODE_INT | Integer Foreign key for the Parent Inventory Code | int | Join to WOMD.InventoryCodes |
PARENT_INVENTORY_CODE_ID | GUID Foreign key for the Parent Inventory Code | uniqueidentifier | GUID, Join to WOMD.InventoryCodes |
DAYPART_INT | Foreign key for Inventory Code’s Daypart | int | Join to WOMD.Lookups |
IS_SELLGROUP | Flag indicating if the Inventory Code is a Sellgroup | int | Any integer value |
REPORTING_NAME | Inventory Code’s Reporting name | varchar(100) | Any string value |
SELLING_NAME_INT | Foreign key for Inventory Code’s Selling Name | int | Join to WOMD.Lookups |
ROW_STATE | Specifies if Inventory Code has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Inventory Code | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created Inventory Code | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of Inventory Code | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who last updated Inventory Code | varchar(250) | Any string value |
WOMD.Lookups
Returns list of Lookup values used in WO Traffic
Input Parameters
Example Request:
{
"RequestType":"WOMD.Lookups",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":[]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
LOOKUP_INT | Lookup ID, integer value | int | Any integer value |
LOOKUP_GUID | Lookup ID | uniqueidentifier | GUID |
LOOKUP_TYPE | Type of Lookup (e.g., Advertiser Type, Agency Type, etc.) | varchar(250) | Any string value |
LOOKUP_VALUE | Lookup Value | varchar(250) | Any string value |
LOOKUP_DISPLAY | Lookup Display, what shows in WO Traffic | varchar(250) | Any string value |
LOOKUP_DESCR | Lookup Description | varchar(250) | Any string value |
LOOKUP_SORT | Lookup Sort | varchar(50) | Any string value |
ROW_STATE | Specifies if Lookup has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
UPDATE_DATE | Last Update Date of Lookup | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.Materials
Returns list of Materials
Input Parameters
Example Request:
{
"RequestType":"WOMD.Materials",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
MATERIAL_ID | Material ID | uniqueidentifier | GUID |
MATERIAL_NAME | Material Name | varchar(50) | Any string value |
MATERIAL_TITLE | Material Title | uniqueidentifier | GUID |
MATERIAL_LENGTH | Material Length (in milliseconds) | int | Any integer value |
ADVERTISER_ID | Foreign key of Material’s Advertiser | uniqueidentifier | GUID, Join to WOMD.Advertisers |
PRODUCT_DESCR | Material’s Product Description | varchar(50) | Any string value |
COOP_CODE | Material Co-op Code | varchar(50) | Any string value |
ISCI_CODE | Material ISCI Code | varchar(50) | Any string value |
HOUSE_NAME | Material House Name | varchar(50) | Any string value |
FCC_TYPE_INT | Foreign key for Material Content Type | int | Join to WOMD.Lookups |
FCC_SOURCE_INT | Foreign Key for Material Content Source | int | Join to WOMD.Lookups |
DISTRIBUTION_SOURCE | Material Distribution Source | varchar(50) | Any string value |
USEABLE_FOR_FILLER | Flag indicating if Material can be used for Filler | int | Any integer value |
ROW_STATE | Specifies if the Material has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Material | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Material | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WO_FIELD1 | Material Field 1 | varchar(50) | Any string value |
WO_FIELD2 | Material Field 2 | varchar(50) | Any string value |
WO_FIELD3 | Material Field 3 | varchar(50) | Any string value |
WO_FIELD4 | Material Field 4 | varchar(50) | Any string value |
WO_FIELD5 | Material Field 5 | varchar(50) | Any string value |
MATERIAL_INT | Integer ID of the Material | int | Any integer value |
MATERIAL_GROUP_NAME | Material Group Name | varchar(10) | Any string value |
MATERIAL_GROUP_DESCRIPTION | Material Group Description | varchar(50) | Any string value |
WOMD.Orders
Returns list of Orders
Input Parameters
Example Request:
{
"RequestType":"WOMD.Orders",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ORDER_ID | Order ID | uniqueidentifier | GUID |
ORDER_NUMBER | Order Number | varchar(50) | Any string value |
ADVERTISER_ID | Foreign Key of Order’s Advertiser | uniqueidentifier | GUID, Join to WOMD.Advertisers |
AGENCY_ID | Foreign Key of Order’s Agency | uniqueidentifier | GUID, Join to WOMD.Agencies |
CANCEL_DATE | Date order was cancel (only if cancelled) | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ORDER_IS_COOP | Flag indicating if Order is a Co-op Order | tinyint | Small integer value |
ORDER_IS_CASH | Flag indicating if Order is a Cash Order | bit | 0 or 1 |
IS_CASH_IN_ADVANCE | Flag indicating if Order is Cash In Advance | bit | 0 or 1 |
CENTRAL_ORDER | Flag indicating if Order is create via WO Central | bit | 0 or 1 |
FLIGHT_START_DATE | Start Date of the Order | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FLIGHT_END_DATE | End Date of the Order | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
SALES_REGION_INT | Foreign Key of Order’s Sales Region | int | Join to WOMD.Lookups |
SALES_OFFICE_ID | Foreign Key of Order’s Sales Office | uniqueidentifier | Join to WOMD.SalesOffices |
BILLING_GROUP_INT | Foreign Key of Order’s Billing Group | int | Join to WOMD.BillingGroup |
DEMO_CODE_INT | Foreign Key of Order’s Demographic | int | Join to WOMD.Lookups |
SHARE_OF_ORDER | Share of the advertiser’s buy | tinyint | Any integer value |
ROW_STATE | Specifies if Order has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Order | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Order | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ORDER_INT | Order ID, integer value | int | Any integer value |
FIRST_APPROVAL_DATE | Order’s First Approval Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ORDER_TYPE_INT | Foreign Key of Order Type | int | Join to WOMD.Lookups |
AGENCY_COMMISSION | Order’s Agency Commission | float | Floating point numeric |
UNITCODE_INT | Foreign Key of Order’s Unit Code | int | Join to WOMD.UnitCodes |
NEW_BUSINESS_DATE | New Business Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
HIATUS_PERIODS | Hiatus Periods | varchar(1000) | Any string value |
HAS_MATERIAL_INSTRUCTION | Flag indicating if Order has Material Instruction | bit | 0 or 1 |
CREATE_BY | Username who Created Order | varchar(250) | Any string value |
BILLING_CALENDAR_INT | Foreign Key of Order’s Billing Calendar | int | Join to WOMD.Lookups |
PRODUCT_CODE_ID | Foreign Key of Order’s Product Code | uniqueidentifier | GUID, Join to WOMD.ProductCodes |
EXTERNAL_ID | Order’s External ID | varchar(50) | Any string value |
PRODUCT_DESCRIPTION | Order’s Product Description | varchar(50) | Any string value |
ALT_ORDER_NUMBER | Order’s Alternate Order Number | varchar(50) | Any string value |
DEFAULT_CHANNEL_INT | Foreign Key for Order’s Channel | int | Join to WOMD.Channels |
CLIENT_TRACKING_NUMBER | Order’s Client Tracking Number | varchar(50) | Any string value |
PRIMARY_ACCOUNT_EXEC_ID | Foreign Key for Order’s Primary Account Exec | uniqueidentifier | GUID, Join to WOMD.AccountExec |
INTERNET_TRAFFICKER_INT | Foreign Key for Digital Order’s Trafficker | int | Join to WOMD.Lookups |
WOMD.OrderAccountExec
Returns list of Order’s Account Execs
Input Parameters
Example Request:
{
"RequestType":"WOMD.OrderAccountExec",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ACCOUNT_EXECUTIVE_ID | Foreign Key for Account Exec | uniqueidentifier | GUID, Join to WOMD.AccountExec |
ORDER_INT | Foreign Key for Order | int | Join to WOMD.Order |
START_DATE | Start date of Account Exec’s commission period | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
END_DATE | End date of Account Exec’s commission period | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
SALES_OFFICE_ID | Foreign Key for Account Exec’s Sales Office | uniqueidentifier | GUID, Join to WOMD.SalesOffices |
SALES_REGION_INT | Foreign Key for Account Exec’s Sales Region | int | Join to WOMD.Lookups |
COMMISSION_PERCENT | Account Exec’s commission rate | float | Floating point numeric |
IS_PRIMARY_AE | Flag indicating if Account Exec is the Primary | bit | 0 or 1 |
CREATE_DATE | Create Date of Order Account Exec record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Order Account Exec record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.OrderBillplanException
Returns list of Order bill plans which are different from order header
Input Parameters
Example Request:
{
"RequestType":"WOMD.OrderBillplanException",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters": []
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ORDER_BILL_PLAN_ID | Order Bill Plan ID | uniqueidentifier | GUID |
ORDER_ID | Foreign Key for Bill Plan’s Order | uniqueidentifier | GUID, Join to WOMD.Order |
ORDER_INT | Foreign Key for Bill Plan’s Order, integer value | int | Join to WOMD.Order |
SEQ_NUM Order | Bill Plan Number | int | Any integer value |
UNIT_START_DATE | Start Date of Bill Plan | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UNIT_END_DATE | End Date of Bill Plan | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
NUMBER_OF_UNITS | Number of Units in Bill Plan | int | Any integer value |
INTERNAL_AMOUNT | Internal Amount of Bill Plan | money | Money value |
EXTERNAL_AMOUNT | External Amount of Bill Plan | money | Money value |
IS_USER_OVERRIDE | User altered Bill Plan | bit | 0 or 1 |
INVOICE_REVISION | Invoice Revision number | smallint | Any small integer value |
ROW_STATE | Specifies if Bill Plan has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Order Bill Plan record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created Bill Plan | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of Order Bill Plan record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated Bill Plan | varchar(250) | Any string value |
AGENCY_ID | Foreign Key for Bill Plan’s Agency | uniqueidentifier | GUID, Join to WOMD.Agencies |
ADVERTISER_ID | Foreign Key for Bill Plan’s Advertiser | uniqueidentifier | GUID, Join to WOMD.Advertisers |
ORDER_SHARE | Share of the advertiser’s buy | float | Floating point numeric |
IS_PLACEHOLDER | Flag indicating if Bill Plan is Placeholder | bit | 0 or 1 |
BILLING_ADDRESS_INT | Foreign Key for Agency’s Billing Address | int | Join to WO_ADDRESSES |
REMIT_ADDRESS_INT | Foreign Key for Agency’s Remit Address | int | Join to WO_ADDRESSES |
AGENCY_COMMISSION | Agency’s Commission | float | Floating point numeric |
BILLPLAN_IS_CASH | Flag indicating if Bill Plan is Cash | bit | 0 or 1 |
WOMD.Payments
Returns list of Payment Processing Levels
Input Parameters
Example Request:
{
"RequestType":"WOMD.Payments",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters": []
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
REPORT_DATE | Reporting date, first day of the month payment is received | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
AMOUNT_PMT | Total amount of cash payments | money | Money |
COUNT_PMT | Total number of cash payments | int | Any integer value |
AMOUNT_CC | Total amount of credit card payments | money | Money |
COUNT_CC | Total number of credit card payments | int | Any integer value |
WOMD.ProductCodes
Returns list of Product Codes
Input Parameters
Example Request:
{
"RequestType":"WOMD.ProductCodes",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
PRODUCT_CODE_ID | Product Code ID | uniqueidentifier | GUID |
PARENT_PRODUCT_CODE_ID | Foreign Key for Product Code’s Parent | uniqueidentifier | GUID, Join back to WOMD.ProductCodes |
PRODUCT_CODE_NAME | Product Code Name | varchar(50) | Any string value |
PRODUCT_CODE_DESCR | Prodcut Code Description | varchar(250) | Any string value |
ROW_STATE | Specifies if Product Code has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Product Code record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Product Code | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created Product Code | varchar(250) | Any string value |
UPDATE_BY | Username of user who updated Product Code | varchar(250) | Any string value |
WOMD.Programs
Returns list of Programs
Input Parameters
Example Request:
{
"RequestType":"WOMD.Programs",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
PROGRAM_ID | Program ID | uniqueidentifier | GUID |
PROGRAM_INT | Program ID, integer value | int | Any integer value |
PROGRAM_NAME | Program Name | varchar(250) | Any string value |
TV_RATING_INT | Foreign Key for Program’s TV Rating | int | Join to WOMD.Lookups |
ROW_STATE | Specifies if Program has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Program record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Program | varchar(250) | Any string value |
PROGRAM_EXTERNAL_ID | Program’s External ID | uniqueidentifier | GUID |
GENRE_INT | Foreign Key for Program’s Genre | int | Join to WOMD.Lookups |
WOMD.SalesOffices
Returns list of Sales Offices
Input Parameters
Example Request:
{
"RequestType":"WOMD.SalesOffices",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":[]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
SALES_OFFICE_ID | Sales Office ID | uniqueidentifier | GUID |
SALES_OFFICE_ABBREVIATION | Sales Office Abbreviation | varchar(20) | Any string value |
SALES_OFFICE_NAME | Sales Office Name | varchar(50) | Any string value |
MAILING_ADDRESS_ID | Foreign Key for Sales Office’s Mailing Address | uniqueidentifier | GUID, Join to WO_ADDRESSES |
REMIT_ADDRESS_ID | Foreign Key for Sales Office’s Remit Address | uniqueidentifier | GUID, Join to WO_ADDRESSES |
SALES_REGION_INT | Sales office ID (integer value) | int | Any integer value |
MAIN_PHONE_NUMBER | Sales Office’s Main Phone Number | varchar(50) | Any string value |
MAIN_FAX_NUMBER | Sales Office’s Fax Number | varchar(50) | Any string value |
ROW_STATE | Specifies if Sales Office has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Sales Office record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created Sales Office | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of Sales Office | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated Sales Office | varchar(250) | Any string value |
STATION_ARRAY | An Array representing the Sales Office’s Stations | binary(64) or binary(256) | Binary(64) for pre-11.0. Binary(256) for ver. 11 and up. |
WOMD.ServerInfo
Returns SQL Server and WideOrbit Info
Input Parameters
Example Request:
{
"RequestType":"WOMD.ServerInfo",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":[]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
NoOfUsers | Number of active Users created in WideOrbit | int | Any integer value |
SQLVersion | SQL Server version where WideOrbit is running | varchar(512) | Any string value |
SQLDateOffset | Number of hours from UTC time; based on time of SQL Server machine | decimal | Any decimal number |
SQLFileSize | File Size of WideOrbit database | int | Any integer value |
TrafficVersion | Version of WideOrbit customer is running | varchar(15) | Any string value |
TrafficBuild | Build number of WideOrbit customer is running | varchar(15) | Any string value |
CentralVersion | WideOrbit Central Version Key | bigint | Any big integer value |
IsNetwork | Flag to indicate whether customer is running WideOrbit Network | bit | 0 or 1 |
SQLCompMode | Compatibility mode of SQL Server | int | Any integer value |
WOMD.Stations
Returns list of Stations
Input Parameters
Example Request:
{
"RequestType":"WOMD.Stations",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":[]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
STATION_ID | Station ID | uniqueidentifier | GUID |
STATION_CALL_LETTERS | Station’s Call Letters | varchar(25) | Any string value |
STATION_NAME | Station’s Name | varchar(50) | Any string value |
AFFILIATION | Foreign Key for Station’s Affiliation | int | Join to WOMD.Lookups |
STATION_MAIN_PHONE | Station’s Main Phone | varchar(50) | Any string value |
STATION_BILLING_PHONE | Station’s Billing Phone | varchar(50) | Any string value |
STATION_WEB_SITE | Station’s Web Site | varchar(50) | Any string value |
ACCOUNTING_CLOSE_DATE | Station’s Last Accounting Close Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
STATION_INT | Station ID, integer value | int | Any integer value |
VERIFIED_CLOSE_DATE | Station’s Last Verified Close Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
MARKET | Stations’ Market | varchar(50) | Any string value |
REGION | Station’s Region | varchar(50) | Any string value |
STATION_TYPE | Foreign Key for Station Type | int | 1 = Airtime, 2 = Internet, 3 = WO Streaming |
STATION_MAIN_ADDRESS_INT | Foreign Key for Station’s Main Address | int | Join to WO_ADDRESSES |
ROW_STATE | Specifies if Station has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of Station record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of Station | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ADDRESS_NAME | Station’s Address Name | varchar(100) | Any string value |
ADDRESS_LINE1 | Station’s | Main Address, Address Line 1 | varchar(100) |
ADDRESS_LINE2 | Station’s | Main Address, Address Line 2 | varchar(100) |
ADDRESS_LINE3 | Station’s | Main Address, Address Line 3 | varchar(100) |
ADDRESS_CITY | Address’s City | varchar(100) | Any string value |
ADDRESS_STATE | Station’s | Main Address, State | varchar(25) |
ADDRESS_ZIPCODE | Station’s | Main Address, Zipcode | varchar(50) |
ADDRESS_COUNTRY | Station’s | Main Address, Country | varchar(100) |
EI_BAND | Station’s Billing Group EI Band | varchar(25) | Any string value |
EI_MEDIA_TYPE | Station’s Billing Group EI Media Type | varchar(25) | Any string value |
EI_NAME | Station’s Billing Group EI Name | varchar(25) | Any string value |
REPORTING_NAME | Station’s Reporting Name | varchar(100) | Any string value |
STATION_GROUP_INT | Foreign Key for Station’s Bill Group | int | Join to WOMD.BillingGroup |
UNIT_CODE_INT | Foreign Key for Station’s default Unit Code | int | Join to WOMD.UnitCodes |
BG_STATION_CALL_LETTERS | Station’s Billing Group Call Letters | varchar(25) | Any string value |
IS_WOX_ENABLED | Flag for whether Billing Group is WO Exchange enabled | tinyint | 0 or 1 |
IS_DEFAULT_STATION | Flag for whether Station is Billing Group’s default station | bit | 0 or 1 |
WOMD.SystemSettings
Returns WideOrbit System Settings
Input Parameters
Example Request:
{
"RequestType":"WOMD.SystemSettings",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":[]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
SYSTEM_SETTING_ID | System Setting ID | uniqueidentifier | GUID |
SYSTEM_NAME | System Name | varchar(50) | Any string value |
SYSTEM_CODE | System Code | varchar(5) | Any string value |
FISCAL_CALENDAR_INT | Foreign Key for System’s Fiscal Calendar | int | Join to WOMD.Lookups |
DEFAULT_DIGITAL_REVENUE_CODE_INT | Foreign Key for Default Digital Revenue Code | int | Join to WOMD.Lookups |
DEFAULT_DIGITAL_REVENUE_CODE2_INT | Foreign Key for Default Digital Revenue Code2 | int | Join to WOMD.Lookups |
DEFAULT_DIGITAL_REVENUE_CODE3_INT | Foreign Key for Default Digital Revenue Code3 | int | Join to WOMD.Lookups |
DEFAULT_DIGITAL_ORDER_TYPE_INT | Foreign Key for Default Digital Order Type | int | Join to WOMD.Lookups |
SYSTEM_LICENSE | System License | text | Any large text value |
ROW_STATE | Specifies if System Setting has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created System Setting | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated System Setting | varchar(250) | Any string value |
WOMD.UnitCodes
Returns list of Unit Codes
Input Parameters
Example Request:
{
"RequestType":"WOMD.UnitCodes",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":[]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
None
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
UNIT_CODE_ID | Unit Code ID | uniqueidentifier | GUID |
UNIT_CODE_INT | Unit Code ID, integer value | int | Any integer value |
UNIT_CODE_CODE | Code Name | varchar(250) | Any string value |
UNIT_CODE_DISPLAY | Display Name | varchar(250) | Any string value |
UNIT_CODE_SORT | Sort | varchar(50) | Any string value |
UNIT_CODE_DESCRIPTION | Description | varchar(250) | Any string value |
EXTERNAL_ID | External ID | varchar(250) | Any string value |
REPORTING_NAME | Reporting Name | varchar(250) | Any string value |
ROW_STATE | Specifies if System Setting has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created System Setting | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated System Setting | varchar(250) | Any string value |
WOMD.Users
Returns list of WideOrbit Users
Input Parameters
Example Request:
{
"RequestType":"WOMD.Users",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
SECURITY_USER_ID | Security User ID | uniqueidentifier | GUID |
EMAIL_ADDRESS | User’s Email Address | varchar(50) | Any string value |
TITLE | User’s Title | varchar(50) | Any string value |
DEPARTMENT | User’s Department | varchar(50) | Any string value |
IS_SUPER_USER | Flag indicating whether user is a Super User | int | 0 or 1 |
IS_DOMAIN_LOGIN | Flag indicating whether this is a Domain Login | int | 0 or 1 |
LAST_LOGIN | Last date/time that user logged into WideOrbit | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
INVALID_LOGIN_ATTEMPTS | Number of Invalid Login Attempts | int | Any integer value |
CREATE_DATE | Create Date of User record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of User record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ROW_STATE | Specifies if System Setting has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
WOMD.ChannelAirDates
Returns list of Log Dates
Input Parameters
Example Request:
{
"RequestType":"WOMD.ChannelAirDates",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
CHANNEL_AIR_DATE_ID | Channel Air Date ID | uniqueidentifier | GUID |
CHANNEL_INT | Foreign Key for the Air Date’s Channel | int | Join to WOMD.Channels |
AIR_DATE | Air Date of Log | smalldatetime | Valid datetime (time is converted to 00:00:00) |
SIGN_ON | Sign On time for Air Date, expressed as milliseconds after midnight | int | Any integer value |
SIGN_OFF | Sign Off time for Air Date, expressed as milliseconds after midnight | int | 0 or 1 |
IS_ALTERED | Flag indicating whether the Log has been modified | int | 0 or 1 |
IS_FINALIZED | Flag indicating whether the Log has been finalized | int | 0 or 1 |
FINALIZE_COUNT | Number of time Log was finalized | int | Any integer value |
FINALIZE_DATE | The last Date the Log was finalized | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
RECONCILE_IN_PROGRESS | Flag indicating whether Log has begun Reconcilation process | int | 0 or 1 |
IS_RECONCILED | Flag indicating whether Log has been completely Reconciled | int | 0 or 1 |
IS_INVOICED | Flag indicating whether Log has been Invoiced | int | 0 or 1 |
IS_FROZEN_TO_ORDERS | Flag indicating whether the Log is Frozen to changes to Orders | int | 0 or 1 |
IS_LOCKED | Flag indicatng whether the Log is Locked | int | 0 or 1 |
EXTENDED_LOG_ACTUAL_START | Extended Log Start Time (for Daylight Savings Time) | int | Any integer value |
EXTENDED_LOG_DISPLAY_START | Extended Log Start Time that is Displayed (for Daylight Savings Time) | int | Any integer value |
EXTENDED_LOG_TYPE | Extended Log Type | int | 0 or 1 |
IS_DELETED | Flag indicating whether Log has been Deleted | bit | 0 or 1 |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created System Setting | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated System Setting | varchar(250) | Any string value |
UPDATE_COUNT | Number of times Log has been Updated | int | Any integer value |
IS_READY_FOR_PROMO | Flag indicating whether Log is Ready to place Promo’s | int | 0 or 1 |
IS_INSERTION_WINDOWS_LOCKED | Flag indicating whether Insertion Windows are Locked | int | 0 or 1 |
PLAYLIST_VERSION | Playlist Version number | smallint | Any integer value |
IS_VERIFIED | Flag indicating whether Log has been Verified | int | 0 or 1 |
PLAYLIST_STATUS | Playlist Status | smallint | Any integer value |
IS_FROZEN_TO_FORMAT_SCHEDULES | Flag indicating whether Log is Frozen to Format Schedule changes | int | 0 or 1 |
WOMD.InternetProduct
Returns list of Internet Products
Input Parameters
Example Request:
{
"RequestType":"WOMD.InternetProduct",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
INTERNET_PRODUCT_ID | Internet Product ID | uniqueidentifier | GUID |
INTERNET_PRODUCT_INT | Internet Product ID, integer value | int | Any integer value |
CHANNEL_INT | Foreign Key for Internet Product’s Channel | int | Join to WOMD.Channels |
INVENTORY_CODE_INT | Foreign Key for Internet Product’s Inventory Code | int | Join to WOMD.InventoryCodes |
AD_SLOT_INT | Foreign Key for Internet Product’s Ad Slot | int | Join to WOMD.Lookups |
AD_TYPE_INT | Foreign Key for Internet Product’s Ad Type | int | Join to WOMD.Lookups |
START_DATE | Start Date of Internet Product | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
END_DATE | End Date of Internet Product | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
NAME | Name of Internet Product | varchar(50) | Any string value |
SORT | Sort of Internet Product | varchar(50) | Any string value |
EXTERNAL_DESCRIPTION | External Description of Internet Product | varchar(250) | Any string value |
KEYWORDS | Keywords of Internet Product | varchar(max) | Ad Server commands |
IS_DELETED | Flag indicating whether Internet Product is Deleted | bit | 0 or 1 |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created System Setting | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated System Setting | varchar(250) | Any string value |
PRODUCT_TYPE_INT | Foreign Key of Internet Product Type | int | Join to WOMD.Lookups |
TARGETING | Targeting of Internet Product | varchar(max) | int value of target (join to WOMD.Lookups) and Target text |
DEFAULT_RATE | Default Rate of Internet Product | int | 0 = CPM, actuals; 1 = CPC; 2 = Flat fee; 3 = CPD, daily; 4 = CPP; 5 = CPD, weekly; 6 = CPD, monthly; 7 = CPM, booked |
ALLOW_IMP_GOAL | Allow Goal | int | 0 or 1 |
DIGITAL_TYPE | Digital Type of Internet Product | int | 1 = Internet, 2 = Streaming |
GOAL_TYPE | Goal Type of Internet Product | int | 1 = Impressions, 2 = Plays |
WOMD.InventoryType
Returns list of Internet Products
Input Parameters
Example Request:
{
"RequestType":"WOMD.InventoryType",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
INVENTORY_TYPE_ID | Inventory Type ID | uniqueidentifier | GUID |
INVENTORY_TYPE_CODE | Inventory Type Code | varchar(50) | Any string value |
INVENTORY_TYPE_DESCR | Inventroy Type Description | varchar(50) | Any string value |
INVENTORY_TYPE_INT | Inventory Type ID, integer value | int | Any integer value |
ROW_STATE | Specifies if System Setting has been deleted or not | int | 0, 1, or 2. 0 or 1 is active record. 2 is a soft deleted row. |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.BillingGroup
Returns list of Billing Groups
Input Parameters
Example Request:
{
"RequestType":"WOMD.BillingGroup",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
BILLING_GROUP_ID | Billing Group ID | uniqueidentifier | GUID |
BILLING_GROUP_INT | Billing Group ID, integer value | int | Any integer value |
BILLING_GROUP_NAME | Billing Group Name | varchar(50) | Any string value |
BILLING_GROUP_DESCR | Billing Group Description | varchar(250) | Any string value |
STATION_INT | Foreign Key for Billing Group’s Station | int | Join to WOMD.Stations |
ALT_CALL_LETTERS | Billing Group’s Station Call Letters | varchar(25) | Any string value |
ALT_STATION_NAME | Billing Group’s Station Name | varchar(50) | Any string value |
ALT_WEB_SITE | Billing Group’s Website | varchar(50) | Any string value |
EI_NAME | Electronic Invoicing Name | varchar(25) | Any string value |
EI_MEDIA_TYPE | Electronic Invoicing Media Type | varchar(25) | Any string value |
EI_BAND | Electronic Invoicing Band | varchar(25) | Any string value |
EC_NAME | Electronic Contracting Name | varchar(25) | Any string value |
IS_DELETED | Flag indicating whether Internet Product is Deleted | bit | 0 or 1 |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
CREATE_BY | Username of user who created System Setting | varchar(250) | Any string value |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_BY | Username of user who updated System Setting | varchar(250) | Any string value |
ENABLED_FOR_WOX | Flag for whether Billing Group is WO Exchange enabled | tinyint | 0 or 1 |
WOMD.SellingElements
Returns list of Selling Elements
Input Parameters
Example Request:
{
"RequestType":"WOMD.SellingElements",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
SELLING_ELEMENT_ID | Selling Element ID | uniqueidentifier | GUID |
SELLING_ELEMENT_INT | Selling Element ID, integer value | int | Any integer value |
SELLING_ELEMENT_NAME | Selling Element Name | varchar(50) | Any string value |
SELLING_ELEMENT_CODE | Selling Element Code | varchar(10) | Any string value |
SELLING_ELEMENT_SORT | Selling Element Sort | varchar(10) | Any string value |
REPORTING_NAME | Selling Element Reporting Name | varchar(100) | Any string value |
IMPRESSIONS_IN_POSTING | Flag indicating whether Impressions are in Posting | bit | 0 or 1 |
HAS_IMPRESSIONS Flag | indicating whether Selling Element has Impressions | bit | 0 or 1 |
SUPPRESS_INVOICE_LINE | Flag indicating whether to suppress in Invoice Line | bit | 0 or 1 |
DEFAULT_INVENTORY_TYPE_INT | Foreign Key for Default Inventory Type | smallint | Join to WOMD.InventoryType |
DEFAULT_BREAK_CODE_INT | Foreign Key for Default Break Code | smallint | Join to WOMD.Lookups |
DEFAULT_SELLING_NAME_RATE_FACTOR | Selling Name Rate Factor | smallint | Between 0 and 100 |
DEFAULT_LENGTH1 | Default Length1 in milliseconds | int | Any integer value |
DEFAULT_LENGTH2 | Default Length2 in milliseconds | int | Any integer value |
DEFAULT_LENGTHS | Default Lengths | varchar(max) | Any string value |
STATION_INT | Foreign Key for Selling Element’s Station | int | Join to WOMD.Stations |
IS_DELETED | Flag indicating whether Internet Product is Deleted | bit | 0 or 1 |
CREATE_DATE | Create Date of System Setting record | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
UPDATE_DATE | Last Update Date of System Setting | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WOMD.InvoiceSummary
Return count of Invoices by Stations
Input Parameters
Example Request:
{
"RequestType":"WOMD.InvoiceSummary",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
STATION_CALL_LETTERS | Station Call Letter | varchar(25) | Station call letters |
INVOICE_COUNT | Number of invoices generated since Last Successful Run | int | Any integer value |
WOMD.Adjustments
Returns list of Adjustments
Input Parameters
Example Request:
{
"RequestType":"WOMD.Adjustments",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@LASTSUCCESSFULRUN",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@LASTSUCCESSFULRUN | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
REPORT_DATA_REVENUE_ID | Report Data Revenue ID | uniqueidentifier | GUID |
ACTIVITY_DATE | Date of Adjustment Activity | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
EFFECTED_DATE | Effected Date of Adjustment | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
STATION_INT | Foreign Key for Adjustment’s Station | int | Join to WOMD.Stations |
ORDER_ID | Foreign Key for Adjustment’s Order | uniqueidentifier | Join to WOMD.Order |
SALES_OFFICE_ID | Foreign Key for Adjustment’s Sales Office | uniqueidentifier | Join to WOMD.SalesOffices |
ACCOUNT_EXECUTIVE_ID | Foreign Key for Adjustment’s Account Executive | uniqueidentifier | Join to WOMD.AccountExec |
ADVERTISER_ID | Foreign Key for Adjustment’s Advertiser | uniqueidentifier | Join to WOMD.Advertisers |
AGENCY_ID | Foreign Key for Adjustment’s Agency | uniqueidentifier | Join to WOMD.Agencies |
SALES_REGION_INT | Foreign Key for Adjustment’s Sales Region | int | Join to WOMD.Lookups |
GROSS_AMOUNT | Adjusted Gross Amount | money | Any money amount |
NET_AMOUNT | Adjusted Net Amount | money | Any money amount |
IS_ADJUSTMENT | Flag indicating whether this is an Adjustment | bit | 0 or 1 |
IS_HIST Flag | indicating whether this is Historical Revenue | bit | 0 or 1 |
PRODUCT_CODE_ID | Foreign Key for Adjustment’s Product Code | uniqueidentifier | Join to WOMD.ProductCodes |
PRIORITY_CODE_INT | Foreign Key for Adjustment’s Priority Code | int | Join to WOMD.Lookups |
REVENUE_CODE1_INT | Foreign Key for Adjustment’s Revenue Code 1 | int | Join to WOMD.Lookups |
REVENUE_CODE2_INT | Foreign Key for Adjustment’s Revenue Code 2 | int | Join to WOMD.Lookups |
REVENUE_CODE3_INT | Foreign Key for Adjustment’s Revenue Code 3 | int | Join to WOMD.Lookups |
UNIT_CODE_INT | Foreign Key for Adjustment’s Unit Code | int | Join to WOMD.UnitCodes |
IS_CASH Flag | indicating whether Adjustment is | Cash Only | bit |
REVENUE_ADJUSTMENT_TYPE | Revenue Adjustment Type | int | 0 = No Adjustment; 1 = Adjust Gross; 2 = Adjust Commission; 3 = Adjust Tax1; 4 = Adjust Tax2 |
WOMD.Pacing
Returns Incremental Pacing Information
Input Parameters
Example Request:
{
"RequestType":"WOMD.Pacing",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@trackingvalue",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@trackingvalue | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ACTIVITY_DATE | Date of Adjustment Activity | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
EFFECTED_DATE | Effected Date of Adjustment | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
STATION_ID | Foreign Key for Revenue’s Activity Station | uniqueidentifier | Join to WOMD.Stations |
ADVERTISER_ID | Foreign Key for Revenue’s Advertiser | uniqueidentifier | Join to WOMD.Advertisers |
AGENCY_ID | Foreign Key for Revenue’s Agency | uniqueidentifier | Join to WOMD.Agencies |
REVENUE_CODE1_INT | Foreign Key for Revenue’s Revenue Code 1 | smallint | Join to WOMD.Lookups |
REVENUE_CODE2_INT | Foreign Key for Revenue’s Revenue Code 2 | smallint | Join to WOMD.Lookups |
REVENUE_CODE3_INT | Foreign Key for Revenue’s Revenue Code 3 | smallint | Join to WOMD.Lookups |
UNIT_CODE_INT | Foreign Key for Revenue’s Unit Code | smallint | Join to WOMD.UnitCodes |
SALES_REGION_INT | Foreign Key for Revenue’s Sales Region | smallint | Join to WOMD.Lookups |
SALES_OFFICE_ID | Foreign Key for Revenue’s Sales Office | uniqueidentifier | Join to WOMD.SalesOffices |
PRODUCT_CODE_ID | Foreign Key for Revenue’s Product Code | uniqueidentifier | Join to WOMD.ProductCodes |
EI_MEDIA_TYPE | Electronic Invoicing Media Type | varchar(25) | Any string value |
CHANGE_AMOUNT | Dollar amount of revenue change | money | Any money value |
ORDER_IS_CASH | Flag indicating whether order is cash | tinyint | |
FILTER_FROM_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against EFFECTED_DATE | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FILTER_END_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against EFFECTED_DATE | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FILTER_DATA_STATE | Flag indicating whether data exists | tinyint | If there are records with 0, means no data was retrieved |
WOMD.PacingEx
Returns Complete Pacing Information
Input Parameters
Example Request:
{
"RequestType":"WOMD.PacingEx",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@trackingvalue",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@trackingvalue | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ORDER_ACTIVITY_ID | Order Activity ID | uniqueidentifier | |
ACTIVITY_DATE | Date of Adjustment Activity | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
EFFECTED_DATE | Effected Date of Adjustment | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
ORDER_ID | Foreign Key for Order ID | uniqueidentifier | Join to WOMD.Orders |
ORDER_INT | Foreign Key for Order ID, integer value | int | Join to WOMD.Orders |
CHANNEL_INT | Foreign Key for Channel | int | Join to WOMD.Channels |
STATION_INT | Foreign Key for Station | int | Join to WOMD.Stations |
CHANGE_AMOUNT | Dollar amount of revenue change | money | Any money value |
CHANGE_TYPE | char(1) | ||
PRIORITY_CODE_INT | Foreign Key for Priority Code | smallint | Join to WOMD.Lookups |
REVENUE_CODE1_INT | Foreign Key for Revenue Code 1 | smallint | Join to WOMD.Lookups |
REVENUE_CODE2_INT | Foreign Key for Revenue Code 2 | smallint | Join to WOMD.Lookups |
REVENUE_CODE3_INT | Foreign Key for Revenue Code 3 | smallint | Join to WOMD.Lookups |
UNIT_CODE_INT | Foreign Key for Unit Code | smallint | Join to WOMD.UnitCodes |
INVENTORY_CODE_ID | Foreign Key for Inventory Code | uniqueidentifier | Join to WOMD.InventoryCodes |
INVENTORY_CODE_INT | Foreign Key for Inventory Code, integer value | int | Join to WOMD.InventoryCodes |
CHANGE_UNITS | Number of Spots that changed | int | Any integer value |
CHANGE_LENGTH | Length of Spots that changed | int | Any integer value |
ACTIVITY_BY | User who created the change | varchar(150) | Any string value |
FILTER_FROM_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against EFFECTED_DATE | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FILTER_END_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against EFFECTED_DATE | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FILTER_DATA_STATE | Flag indicating whether data exists | tinyint | If there are records with 0, means no data was retrieved |
WOMD.Spot
Returns incremental lists of Spots
Input Parameters
Example Request:
{
"RequestType":"WOMD.Spot",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@trackingvalue",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@trackingvalue | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
STATION_ID | Foreign Key for Station | uniqueidentifier | Join to WOMD.Stations |
ADVERTISER_ID | Foreign Key for Advertiser | uniqueidentifier | |
AGENCY_ID | Foreign Key for Agency | uniqueidentifier | |
BOOKED_DAYPART_INT | Foreign Key for Booked Daypart | int | |
PLACED_DAYPART_INT | Foreign Key for Placed Daypart | int | |
ISCI_CODE | ISCI Code of Material | varchar(50) | |
INTENDED_AIR_DATE | Intended Air Date of Spot | smalldatetime | |
SALES_REGION_INT | Foreign Key for Sales Region | int | |
ORDER_CREATE_DATE | Order Create Date | smalldatetime | |
SPOT_LENGTH | Spot Length in milliseconds | int | |
CHANNEL_INT | Foreign Key for Channel | int | |
GROSS_REVENUE | Gross Revenue | money | |
PRODUCT_CODE_ID | Foreign Key for Product Code | uniqueidentifier | |
ORDER_IS_CASH | Flag indicating if Order Is Cash | tinyint | |
INVENTORY_TYPE_INT | Foreign Key for Inventory Type | int | |
BREAK_CODE_INT | Foreign Key for Break Code | int | |
PROGRAM_INT | Foreign Key for Program | int | |
INVENTORY_CODE_INT | Foreign Key for Inventory Code | int | |
MARKETPLACE_INT | Foreign Key for Marketplace | int | |
FILTER_FROM_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against INTENDED_AIR_DATE | smalldatetime | |
FILTER_END_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against INTENDED_AIR_DATE | smalldatetime | |
FILTER_DATA_STATE | Flag indicating whether data exists | tinyint | If there are records with 0, means no data was retrieved |
WOMD.SpotEx
Returns complete lists of Spots
Input Parameters
Example Request:
{
"RequestType":"WOMD.SpotEx",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@trackingvalue",
"DbType":"smalldatetime",
"Value":"2018-12-31 12:00:00"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
@trackingvalue | Last date/time that data was requested | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
ORDER_LINE_UNIT_ID | Order Line Unit (Spot) ID | uniqueidentifier | GUID |
OVERRIDE_INVENTORY_CODE_INT | Foreign Key for Spot’s Reconciled Inventory Code if different that booked | int | Join to WOMD.InventoryCodes |
INVENTORY_CODE_INT | Foreign Key for Spot’s Inventory Code | int | Join to WOMD.InventoryCodes |
AD_SLOT_INT | Foreign Key for Spot’s Ad Slot | smallint | Join to WOMD.Lookups |
AD_TYPE_INT | Foreign Key for Spot’s Ad Type | smallint | Join to WOMD.Lookups |
FREQUENCY_INTERVAL | Time Interval for Internet Spot | smallint | Interval is 2 in this example: 3 times every 2 hours |
FREQUENCY_NUMBER | Number of times within an interval Internet Spot runs | smallint | Frequency Number is 3 in this example: 3 time every 2 hours |
FREQUENCY_TYPE | Type of time interval for Internet Spot | tinyint | 0 = minutes; 1 = hours; 2 = days; 3 = weeks; 4 = months; 5 = lifetime |
INTERNET_PRIORITY | Internet Spot’s Internet Priority | tinyint | 0 to 100 |
INTERNET_PRODUCT_INT | Foreign Key for Internet Spot’s Internet Product | int | Join to WOMD.InternetProduct |
PRODUCT_TYPE_INT | Foreign Key for Internet Spot’s Product Type | smallint | Join to WOMD.Lookups |
RATE_TYPE_INT | Foreign Key for Internet Spot’s Rate Type | tinyint | 0 = CPM-Actuals; 1 = CPC; 2 = Flat rate; 3 = CPD, Daily; 4 = CPP; 5 = CPD, Weekly; 6 = CPD, Monthly; 7 = CPM, Booked |
RECONCILED_AMOUNT | Internet Spot’s Reconciled Dollar Amount | money | Any money value |
RECONCILED_CLICKS | Internet Spot’s Reconciled Number of Clicks | int | Any integer value |
RECONCILED_IMPRESSIONS | Internet Spot’s Reconciled Number of Impressions | int | Any integer value |
THIRD_PARTY_AD_SERVER_INT | Foreign Key for Internet Spot’s Third Party Ad Server | smallint | Join to WOMD.Lookups |
INTERNET_WEIGHT | Internet Weight | tinyint | Any tiny integer value |
LINE_NUMBER | Order Line Number | int | Any integer value |
ADVERTISER_BRAND_INT | Foreign Key for Spot’s Advertiser Brand | smallint | Join to WOMD.AdvertiserBrands |
AGREED_IMPRESSIONS | Agreed Impressions | int | Any integer value |
AGREED_INVENTORY_RATING | Agreed Inventory Rating | float | Any float value |
AIR_TIME1 | Spot’s Air Time1 in milliseconds past midnight | int | Any integer value |
AIR_TIME2 | Spot’s Air Time2 in milliseconds past midnight (if two part Spot) | int | Any integer value |
SPOT_BREAK_CODE_INT | Foreign Key for Spot’s Break Code | smallint | Join to WOMD.Lookups |
CHANNEL_INT | Foreign Key for Spot’s Channel | smallint | Join to WOMD.Channels |
CREATE_DATE | Create Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
EXTERNAL_AMOUNT | External Amount of Spot | money | Any money value |
H_REVENUE_CODE1_INT | Foreign Key for Revenue Code 1 for internal rate 2 | smallint | Join to WOMD.Lookups |
H_REVENUE_CODE2_INT | Foreign Key for Revenue Code 2 for internal rate 2 | smallint | Join to WOMD.Lookups |
H_REVENUE_CODE3_INT | Foreign Key for Revenue Code 3 for internal rate 2 | smallint | Join to WOMD.Lookups |
HAS_PRODUCT_EXCLUSIVITY | Flag indicating whether Spot has Product Exclusivity | bit | 0 or 1 |
INTENDED_AIR_DATE | Intended Air Date of Spot | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
INTERNAL_AMOUNT | Internal Amount (Internal Rate 1) of Spot | money | Any money value |
INVENTORY_DESCR | Inventory Description | varchar(150) | Any string value |
INVENTORY_TYPE_INT | Foreign Key for Spot’s Inventory Type | smallint | Join to WOMD.InventoryType |
INVOICE_INT | Foreign Key for Spot’s Invoice | int | Join to WO_INVOICES |
IS_BONUS | Flag indicating whether the Spot is a Bonus Spot | bit | 0 or 1 |
IS_BUYER_APPROVED | Flag indicating whether the Spot is Buyer Approved | tinyint | 0 or 1 |
IS_CREDITED | Flag indicating whether the Spot is Credited | bit | 0 or 1 |
IS_LATE_ADD | Flag indicating whether the Spot is a Late Add | bit | 0 or 1 |
IS_LOCKED | Flag indicating whether the Spot is Locked | bit | 0 or 1 |
IS_MAKEGOOD | Flag indicating whether the Spot is a Makegood | bit | 0 or 1 |
IS_PENDING | Flag indicating whether the Spot is Pending (in edit state) | bit | 0 or 1 |
IS_PLACEABLE | Flag indicating whether the Spot is Placeable | bit | 0 or 1 |
IS_PLACED | Flag indicating whether the Spot is Placed | bit | 0 or 1 |
IS_PLACED_REVENUE_ONLY | Flag indicating whether the Spot is Placed for Revenue Only | bit | 0 or 1 |
IS_REJECTED | Flag indicating whether the Spot is Rejected | bit | 0 or 1 |
IS_UNRESOLVED | Flag indicating whether the Spot is Unresolved | bit | 0 or 1 |
IS_USER_MODIFIED | Flag indicating whether the Spot is User Modified | bit | 0 or 1 |
LENGTH1 | Length1 in milliseconds | int | Any integer value |
LENGTH2 | Length2 in milliseconds (if two part Spot) | int | Any integer value |
MATERIAL_INT1 | Spot’s Material Int1 | int | Join to WOMD.Materials |
MATERIAL_INT2 | Spot’s Material Int2 | int | Join to WOMD.Materials |
OVERRIDE_BREAK_CODE_INT | Foreign Key for Spot’s Reconciled Break Code if different that booked | smallint | Join to WOMD.Lookups |
POSTED_IMPRESSIONS | Spot’s Posted Impressions | float | Any float value |
POSTED_RATING | Spot’s Posted Rating | float | Any float value |
SPOT_PRIORITY_CODE_INT | Foreign Key for Spot’s Reconciled Priority Code if different that booked | smallint | Join to WOMD.Lookups |
PROGRAM_INT | Foreign Key for Spot’s Reconciled Program Int | int | Join to WOMD.Program |
PREEMPTED_DATE | Foreign Key for Spot’s Reconciled Preempted Date | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
REVENUE_CODE_INT | Foreign Key for Revenue Code 1 | smallint | Join to WOMD.Lookups |
REVENUE_CODE2_INT | Foreign Key for Revenue Code 2 | smallint | Join to WOMD.Lookups |
REVENUE_CODE3_INT | Foreign Key for Revenue Code 3 | smallint | Join to WOMD.Lookups |
SELLING_ELEMENT_INT | Foreign Key for Spot’s Selling Element | smallint | Join to WOMD.SellingElement |
SPOT_NUMBER | Spot Number | smallint | Any integer value |
STATION_INT | Foreign Key for Spot’s Station | smallint | Join to WOMD.Stations |
UNIT_CODE_INT | Foreign Key for Spot’s Unit Code | smallint | Join to WOMD.UnitCodes |
UPDATE_DATE | Update Date | datetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
WAS_MADEGOOD | Flag indicating whether the Spot was Madegood | bit | 0 or 1 |
TILE_HEIGHT | Tile Height of Internet Spot | smallint | Any small integer value |
TILE_WIDTH | Tile Width of Internet Spot | smallint | Any small integer value |
SPOT_CHANNEL_ARRAY | Channels that Spot is ordered to | varchar(1000) | Binary |
LINE_CHANNEL_ARRAY | Channels that line is ordered to | varchar(1000) | Binary |
ORDER_INT | Foreign Key for Spot’s Order | int | Join to WOMD.Order |
ORDER_NUMBER | Order Number of Spot | varchar(50) | Any string value |
STATION_ID | Foreign Key for Spot’s Station | uniqueidentifier | Join to WOMD.Stations |
IS_INTERNET_LINE | Flag indicating whether the order line is a Internet Line | bit | 0 or 1 |
IS_SALES_MAKEGOOD | Flag indicating whether Spot is a Sales Makegood | bit | 0 or 1 |
IS_CLEARED_CIA | Flag indicating whether Spot is Cleared from Cash In Advance | bit | 0 or 1 |
FILTER_FROM_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against INTENDED_AIR_DATE | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FILTER_END_DATE | Data is merged by deleting all data for returned period in target table and inserting new set. Value of FILTER_FROM_DATE and FILTER_END_DATE fields can be used to determine data to delete against INTENDED_AIR_DATE | smalldatetime | Valid datetime (e.g., 2018-12-31 12:00:00) |
FILTER_DATA_STATE | Flag indicating whether data exists | tinyint | If there are records with 0, means no data was retrieved |
WOMD.Revenue
Returns Revenue Distribution for a date range. One dataset of non-preempted spots and another for preempted spots.
Input Parameters
Example Request:
{
"RequestType":"WOMD.Revenue",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@startdate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@enddate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@stationIdList",
"DbType":"varchar",
"Value":"12345"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
startdate | Start date of date range to pull revenue data | date | Valid datetime (e.g., 2018-12-31) |
enddate | End date of date range to pull revenue data | date | Valid datetime (e.g., 2018-12-31) |
stationIdList | Comma separated list of Station ID’s | varchar(max) | List of GUID’s |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
PROPERTY | Station Call Letters | varchar(50) | Any string value |
STATION_INT | Station ID, integer value | integer | Any integer value |
CHANNEL | Channel Name | varchar(106) | Any string value |
CHANNEL_INT | Channel ID, integer value | int | Any integer value |
CHANNEL_ARRAY | Array representing channels where the order was placed, if multi-channel order | varchar(1000) | Any string value |
ADVERTISER_NAME | Advertiser Name | varchar(50) | Any string value |
ADVERTISER_MDM_ID | Advertiser MDM ID | int | Any integer value |
ADVERTISER_EXTERNAL_ID | Advertiser External ID | varchar(50) | Any string value |
YEAR_NUMBER | Year | int | Gregorian calendar year |
MONTH_NUMBER | Month | int | Gregorian calendar month |
DEMOGRAPHIC | Demographic | varchar(250) | Any string value |
ORDER_TYPE | Order Type | varchar(250) | Any string value |
CASH_OR_TRADE | Cash or Trade Order | varchar(10) | Value is either “CASH” or “TRADE” |
AGENCY_NAME | Agency Name | varchar(50) | Any string value |
AGENCY_MDM_ID | Agency MDM ID | int | Any integer value |
AGENCY_EXTERNAL_ID | Agency External ID | varchar(50) | Any string value |
SALES_OFFICE_NAME | Sales Office Name | varchar(50) | Any string value |
AE_CODE | Account Executive Abbreviation Code | varchar(5) | Any string value |
SALES_PERSON | Account Executive | varchar(101) | Any string value |
SALES_REGION | Sales Region | varchar(250) | Any string value |
PARENT_PRODUCT_CODE_NAME | Parent Product Code Name | varchar(250) | Any string value |
PRODUCT_CODE_NAME | Product Code Name | varchar(50) | Any string value |
INVENTORY_CODE | Ordered Inventory Code Name | varchar(50) | Any string value |
REVENUE_CODE1 | Revenue Code 1 Name | varchar(250) | Any string value |
REVENUE_CODE2 | Revenue Code 2 Name | varchar(250) | Any string value |
REVENUE_CODE3 | Revenue Code 3 Name | varchar(250) | Any string value |
UNIT_CODE_CODE | Unit Code Name | varchar(250) | Any string value |
CALENDAR_TYPE | Calendar Type (e.g., Broadcast, Calendar, etc.) | varchar(250) | Any string value |
SHARE_OF_ORDER | Share of Order | tinyint | Any tiny integer value |
ORDER_NUMBER | Order Number | varchar(50) | Any string value |
BRAND_NAME | Brand Name | varchar(250) | Any string value |
NET_AMOUNT | Net Revenue | money | Money value |
GROSS_AMOUNT | Gross Revenue | money | Money value |
IS_DIRECT | Flag indicating whether Advertiser is a Direct Advertiser | bit | 0 or 1 |
IS_INTERNAL_RATE2 | Flag indicating whether the revenue data is for Internal Rate 2 | bit | 0 or 1 |
WOMD.Aging
Returns Aging report
Input Parameters
Example Request:
{
"RequestType":"WOMD.Aging",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@startdate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@enddate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@StationList",
"DbType":"varchar",
"Value":"12345"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
startdate | Start date of date range to pull revenue data | date | Valid datetime (e.g., 2018-12-31) |
enddate | End date of date range to pull revenue data | date | Valid datetime (e.g., 2018-12-31) |
StationList | Comma separated list of Station ID’s | varchar(max) | List of GUID’s |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
Station | Station Call Letters | varchar(50) | Any string value |
AE Full Name | Account Executive’s Full Name | varchar(110) | Any string value |
Advertiser | Advertiser Name | varchar(50) | Any string value |
Agency | Agency Name | varchar(50) | Any string value |
Order # | Order Number | varchar(50) | Any string value |
Total Due | Total Amount Due | money | Any money value |
Date | Date of Invoice | smalldatetime | Valid datetime (e.g., 2018-12-31) |
Billing Month | Billing Month of Invoice | varchar(50) | Any string value |
AGENCY_NAME_NO_CITY | Agency Name without Billing City | varchar(300) | Any string value |
Estimate # | Estimate Number | varchar(50) | Any string value |
Original Invoice | Original Invoice Number | varchar(50) | Any string value |
Total Payments | Total Payments made towards invoice | money | Any money value |
Invoice # | Invoice Number | varchar(50) | Any string value |
Agency Credit Rating | Agency’s Credit Rating | varchar(250) | Any string value |
Order Product Description | Order’s Product Description | varchar(250) | Any string value |
Current | Amount Currently Due | money | Any money value |
30 Days | Amount Due, 30 days old | money | Any money value |
60 Days | Amount Due, 60 days old | money | Any money value |
90 Days | Amount Due, 90 days old | money | Any money value |
120 Days | Amount Due, 120 days old | money | Any money value |
150+ Days | Amount Due, 150 or more days old | money | Any money value |
WOMD.DaypartInventory
Returns Inventory By Daypart and Inventory Code
Input Parameters
Example Request:
{
"RequestType":"WOMD.DaypartInventory",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@startdate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@enddate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@StationList",
"DbType":"varchar",
"Value":"12345"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
startdate | Start date of date range to pull revenue data | date | Valid datetime (e.g., 2018-12-31) |
enddate | End date of date range to pull revenue data | date | Valid datetime (e.g., 2018-12-31) |
StationList | Comma separated list of Station ID’s | varchar(max) | List of GUID’s |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
STATION | Station Call Letters | varchar(50) | Any string value |
DAYPART | Daypart of Inventory | varchar(250) | Any string value |
DAY | Day of Inventory | smalldatetime | Valid datetime (e.g., 2018-12-31) |
CAPACITY_MINUTES | Capacity of Inventory in Minutes | float | Any float number |
MAX_UNITS | Maximum number of units as defined in format break | smallint | Any small integer value |
INVENTORY | Inventory Code | varchar(250) | Any string value |
INVENTORY_REPORTING_NAME | Inventory Code Reporting Name | varchar(250) | Any string value |
WOMD.Invoices
Returns Invoice Header information
Input Parameters
Example Request:
{
"RequestType":"WOMD.Invoices",
"DataExportFormat":"JSON",
"TargetUrl":"https://yoursite.com/ProcessData",
"ChunkRowsCount":"50",
"GenerateInValidFormat":"true",
"Parameters":
[
{
"Name":"@startdate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@enddate",
"DbType":"datetime",
"Value":"2018-12-31"
},
{
"Name":"@Invoice_Batch_Id",
"DbType":"uniqueidentifier",
"Value":"12345"
},
{
"Name":"@Station_Int",
"DbType":"integer",
"Value":"12345"
}
]
}
Example Error:
{
"Message": "There is no DDL's with request type - WOMD.AE for Agreement YOU/PM_v110"
}
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
Start_Date | Start date of time range for invoice create or update date | smalldatetime | Valid datetime (e.g., 2018-12-31) |
End_Date | End date of time range for invoice create or update range | smalldatetime | Valid datetime (e.g., 2018-12-31) |
Invoice_Batch_Id | Find invoices in this batch | uniqueidentifier | GUID |
Station_Int | Find invoices for this station | integer | Join to WOMD.Stations |
Output Fields
Field Name | Description | Data Type | Supported Values |
---|---|---|---|
INVOICE_ID | Invoice Id | uniqueidentifier | Join to WOMD.Stations |
INVOICE_NUMBER | Invoice Number | varchar(50) | Any string value |
INVOICE_INT | Invoice Id, integer value | integer | Any integer value |
INVOICE_CREATE_DATE | Invoice Create Date | smalldatetime | Valid datetime (e.g., 2018-12-31) |
INVOICE_UPDATE_DATE | Invoice Update Date | smalldatetime | Valid datetime (e.g., 2018-12-31) |
INVOICE_STATUS | Invoice Status | integer | Reference code |
INVOICE_IS_EDITED | Flag to indicate whether the invoice has been edited | varchar | ‘Yes’ or ‘No’ |
STATION_ID | Station Id of invoice | uniqueidentifier | Join to WOMD.Stations |
STATION_INT | Station Int of invoice | integer | Join to WOMD.Stations |
STATION_NAME | Station Name of invoice | varchar(50) | Any string value |
STATION_CALL_LETTERS | Station Call letters of invoice | varchar(25) | Any string value |
CREDIT_INVOICE_NUMBER | Invoice number of the previous credit if one exists | varchar(50) | Any string value |
CREDIT_INVOICE_DATE | Invoice date of the previous credit if one exists | smalldatetime | Valid datetime (e.g., 2018-12-31) |
BILLING_MONTH | Invoice Bill Month | varchar(50) | Gregorian month name |
INVOICE_DATE | Invoice Bill Date | smalldatetime | Valid datetime (e.g., 2018-12-31) |
BILL_TO_NAME | Bill to Name | varchar(50) | Any string value |
BILL_TO_ATTENTION | Bill to Attention | varchar(110) | Any string value |
AGENCY_ID | Agency Id of invoice | uniqueidentifier | Join to WOMD.Agencies |
DUNS_NUMBER | Duns number of agency | varchar(50) | Any string value |
PRODUCT_DESCRIPTION | Order product description | varchar(50) | Any string value |
CLIENT_TRACKING_NUMBER | Order tracking number (estimate from application) | varchar(50) | Any string value |
COMBO_DISPLAY | Combo type of order | varchar(50) | ‘Master’ or ‘Sub’ |
SPECIAL_HANDLING | Special Handling | varchar(250) | Any string value |
SPECIAL_HANDLING_CODE | Special Handling Code | varchar(250) | Any string value |
TAX_RATE1 | Tax Rate1 of order | float | Any float number |
TAX_RATE2 | Tax Rate2 of order | float | Any float number |
HANDLING_STATUS | Handling Status | varchar(50) | ‘Normal’ or ‘Special’ |
EI_STATUS | Electronic Invoice Status | varchar(50) | ‘IS ELECTRONIC’ or ‘ONLY PAPER’ |
INVOICE_CODE | Invoice Code | varchar(50) | Any string value |
AGENCY_PRODUCT_CODE | Agency Product Code (EDI value) | varchar(50) | Any string value |
CLIENT_CODE | Client Code (EDI value) | varchar(50) | Any string value |
EI_EXPORT_TYPE | Electronic Invoice Export Type | tinyint | Reference code |
INVOICE_PERIOD_START_DATE | Start of invoice period | smalldatetime | Valid datetime (e.g., 2018-12-31) |
INVOICE_PERIOD_END_DATE | End of invoice period | smalldatetime | Valid datetime (e.g., 2018-12-31) |
BILL_PLAN_IS_USER_OVERRIDE | Flag to indicate if Bill Plan has been modified | bit | 0 or 1 |
ALT_ORDER_NUMBER | Alternate order number | varchar(50) | Any string value |
IS_CASH | Flag indicating if order is cash | bit | 0 or 1 |
IS_COOP | Flag indicating if order is a coop order | bit | 0 or 1 |
NEW_BUSINESS_DATE | New business date (all revenue behind this date is considered new business) | smalldatetime | Valid datetime (e.g., 2018-12-31) |
ORDER_TYPE_INT | Order type int | integer | Join to WOMD.Lookups |
ORDER_PLUS_ID | Order Plus Id | uniqueidentifier | Join to WOMD.Orders |
IDB_NUMBER | IDB Number | varchar(50) | Any string value |
ORDER_START_DATE | Order Flight Start Date | smalldatetime | Valid datetime (e.g., 2018-12-31) |
ORDER_END_DATE | Order Flight End Date | smalldatetime | Valid datetime (e.g., 2018-12-31) |
ORDER_DESCR | Order description | varchar(50) | Any string value |
BILLING_GROUP_INT | Billing Group Int | integer | Join to WOMD.BillingGroup |
BILLING_GROUP_NAME | Billing Group Name | varchar(50) | Any string value |
REV_CODE1_INT | Revenue Code 1 int | integer | Join to WOMD.Lookups |
REV_CODE2_INT | Revenue Code 2 int | integer | Join to WOMD.Lookups |
REV_CODE3_INT | Revenue Code 3 int | integer | Join to WOMD.Lookups |
UNIT_CODE_INT | Unit Code int | integer | Join to WOMD.UnitCodes |
UNIT_CODE_DESCR | Unit Code description | varchar(50) | Any string value |
TOTAL_INVOICE_AMOUNT | Total Invoice Amount | money | Any money value |
OUTSTANDING_AMOUNT | Outstanding balance amount | money | Any money value |
NUMBER_OF_UNITS | Number of spots included in invoice | integer | Any money value |
GROSS_AMOUNT | Gross amount of invoice | money | Any money value |
NET_AMOUNT | Net amount of invoice | money | Any money value |
AGENCY_COMMISSION | Agency commission | money | Any money value |
AGENCY_DISCOUNT | Agency discount | money | Any money value |
TAX1_AMOUNT | Total Tax 1 amount | money | Any money value |
TAX2_AMOUNT | Total Tax 2 amount | money | Any money value |
PRIMARY_ACCOUNT_EXEC_ID | Primary Account Executive Id | uniqueidentifier | Join to WOMD.AccountExecutives |
SALES_OFFICE_ID | Sales Office Id | uniqueidentifier | Join to WOMD.SalesOffices |
SALES_REGION_INT | Sales Region int | integer | Join to WOMD.Lookups |
BILLING_CALENDAR_INT | Billing Calendar int | integer | Join to WOMD.Lookups |
BILLING_CYCLE_INT | Billing Cycle int | integer | Join to WOMD.Lookups |
ADVERTISER_ID | Advertiser Id | uniqueidentifier | Join to WOMD.Advertisers |
ORDER_NUMBER | Order Number | varchar(50) | Any string value |
ADVERTISER_ADDRESS_CITY | Advertiser Address city | varchar(100) | Any string value |
ADVERTISER_ADDRESS_COUNTRY | Advertiser Address country | varchar(100) | Any string value |
ADVERTISER_ADDRESS_LINE1 | Advertiser Address line1 | varchar(100) | Any string value |
ADVERTISER_ADDRESS_LINE2 | Advertiser Address line2 | varchar(100) | Any string value |
ADVERTISER_ADDRESS_LINE3 | Advertiser Address line3 | varchar(100) | Any string value |
ADVERTISER_ADDRESS_NAME | Advertiser Address name | varchar(100) | Any string value |
ADVERTISER_ADDRESS_STATE | Advertiser Address state | varchar(100) | Any string value |
ADVERTISER_ADDRESS_POSTAL_CODE | Advertiser_Address_Postal Code | varchar(100) | Any string value |
ORDER_INT | Order Int | integer | Join to WOMD.Orders |
ORDER_PLUS_INT | Order Plus int | integer | Join to WOMD.Orders |
PENDING_LINK_ORDER_ID | Pending_Link_Order Id | uniqueidentifier | Join to WOMD.Orders |
BILLING_ADDRESS_INT | Billing Address int | integer | Join to WOMD.Addresses |
CAMPAIGN_NUMBER | Campaign Number | varchar(50) | Any string value |
ORDER_TYPE_DESCR | Order Type description | varchar(250) | Any string value |
ORDER_TYPE_DISPLAY | Order Type display | varchar(250) | Any string value |
ORDER_TYPE | Order Type | varchar(250) | Any string value |
REVENUE_CODE1_DESCR | Revenue Code1 descr | varchar(250) | Any string value |
REVENUE_CODE2_DESCR | Revenue Code2 descr | varchar(250) | Any string value |
REVENUE_CODE3_DESCR | Revenue Code3 descr | varchar(250) | Any string value |
AGENCY_NAME | Agency Name | varchar(50) | Any string value |
ADVERTISER_NAME | Advertiser Name | varchar(50) | Any string value |
SALES_OFFICE_NAME | Sales Office name | varchar(250) | Any string value |
SALES_REGION_DESCR | Sales Region description | varchar(250) | Any string value |
SALES_REGION_DISPLAY | Sales Region display | varchar(250) | Any string value |
SALES_REGION | Sales Region | varchar(250) | Any string value |
ACCOUNT_EXEC_CODE | Account Exec code | varchar(5) | Any string value |
ACCOUNT_EXEC_NAME | Account Exec name | varchar(110) | Any string value |
ACCOUNT_EXEC_PHONE | Account Exec phone | varchar(100) | Any string value |
BILLING_CALENDAR | Billing Calendar | varchar(250) | Any string value |
BILLING_ADDRESS_LINE1 | Billing Address line1 | varchar(100) | Any string value |
BILLING_ADDRESS_LINE2 | Billing Address line2 | varchar(100) | Any string value |
BILLING_ADDRESS_CITY | Billing Address city | varchar(100) | Any string value |
BILLING_ADDRESS_STATE | Billing Address state | varchar(100) | Any string value |
BILLING_ADDRESS_POSTAL_CODE | Billing_Address_Postal Code | varchar(100) | Any string value |
BILLING_ADDRESS_COUNTRY | Billing Address country | varchar(100) | Any string value |
STATION_ADDRESS_LINE1 | Station Address line1 | varchar(100) | Any string value |
STATION_ADDRESS_LINE2 | Station Address line2 | varchar(100) | Any string value |
STATION_ADDRESS_CITY | Station Address city | varchar(100) | Any string value |
STATION_ADDRESS_STATE | Station Address state | varchar(100) | Any string value |
STATION_ADDRESS_POSTAL_CODE | Station_Address_Postal Code | varchar(100) | Any string value |
REMIT_ADDRESS_LINE1 | Remit Address line1 | varchar(100) | Any string value |
REMIT_ADDRESS_LINE2 | Remit Address line2 | varchar(100) | Any string value |
REMIT_ADDRESS_CITY | Remit Address city | varchar(100) | Any string value |
REMIT_ADDRESS_STATE | Remit Address state | varchar(100) | Any string value |
REMIT_ADDRESS_POSTAL_CODE | Remit_Address_Postal Code | varchar(100) | Any string value |
STATION_PHONE | Station Phone | varchar(50) | Any string value |
BILLING_PHONE | Billing Phone | varchar(50) | Any string value |
GLOBAL_AGENCY_ID | Global Agency id | varchar(50) | Any string value |
EXTERNAL_AGENCY_CODE | External Agency code | varchar(50) | Any string value |
GLOBAL_ADVERTISER_ID | Global Advertiser id | varchar(50) | Any string value |
EXTERNAL_ADVERTISER_CODE | External Advertiser code | varchar(50) | Any string value |
IS_CASH_IN_ADVANCE | Flag indicating whether order is Cash In Advance | bit | 0 or 1 |
REMARKS | Remarks | varchar(50) | Any string value |
SUPPRESS_CLICKS | Flag indicating whether to suppress clicks on invoice | bit | 0 or 1 |
SUPPRESS_CREDITS | Flag indicating whether to suppress credits on invoice | bit | 0 or 1 |
SUPPRESS_IMPRESSIONS | Flag indicating whether to suppress impressions on invoice | bit | 0 or 1 |
SUPPRESS_LINE_AMOUNTS | Flag indicating whether to suppress line amounts on invoice | bit | 0 or 1 |
IS_DIRECT_ADVERTISER | Flag indicating if Advertiser is a Direct Advertiser | bit | 0 or 1 |
ORDER_EXTERNAL_ID | External id of order | varchar(50) | Any string value |