Back History
Rumple (Technical Details)

<div id="Text">
==Rumple (Technical Details)==
[Rumple|back]
{br}
<center><a href=http://rumple.com><img src=https://www.rumple.com/img/nav_logo.gif></a></center>

===Introduction===

This page contains the technical (behind the scenes) details as related to our integration with [Rumple]; as such, it is not intended to be used by our end-users.

===API===

The API currently available utilizes the HTTP GET protocol.

{{{{pull.aspx?'''x'''=rumple&'''g'''=''APPCODE''&'''t'''=cust&'''f'''=json}}}}

This HTTP GET script can be accessed via:

{{{{http://traf.com/data/}}}}

====Variables====

The following variables are currently available:

* '''x''' (required) - The ''eXchanger''; the third-party product using the API... in this case '''rumple'''.
* '''g''' (required) - The ''group'' APPCODE; this is the APPCODE accessible from within the [Group] window (from the [Dashboard] using the [Settings] icon).
* '''t''' (optional) - ''Type'' of data (see below).
* '''f''' (optional) - ''Format'' of the data (see below).
* '''s''' (optional) - Filter to ''Station'' list.  This variable is optional; however, if included the resulting data will be limited to the list of call letters supplied.  If not included (the default), all stations are included in the result.  (This, of course, assumes that the data is "station-centric".)
* '''p''' (optional) - The "Pivot" date; the default pivot date (if not provided) for the data retrieved defaults to ''today''.  However, there are cases where the data being pulled for historical purposes is desired.
* '''n''' (optional) - Pull using "NET" numbers.  If not included (the default), the value is "true" (unless using a specific "gross" style, legacy, report).

((('''CS''' Please keep in mind that the following samples are "live" and are only available if one of our QA servers is actively enabled to return the following data.  If you find this to not be the case and need this to be so, please let know by either [SendSmile|Sending a Smile] or contacting customer service.)))

====Type====

* Customers
** '''cust''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=cust&f=json|sample]){br}Active customer list.
* Billing History
** '''billinit''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=billinit&n=true&f=json|sample]){br}Overall billing history covering the active portion of this year plus all of the prior year.  Each record represents one billing entry that occurred on a recorded "end_date".
** '''billhist''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=billhist&n=true&f=json|sample]){br}Billing history covering "last month". Each record represents one billing entry that occurred on a recorded "end_date".
* Projections
** '''proj''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=proj&n=true&f=json|sample]){br}Gross revenue projections for 3 months.  The report generated will return 3 columns of projections numbered 1 through 3 where the first column represents the month of the specified pivot date.
** '''proj12''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=proj12&n=true&f=json|sample]){br}Gross revenue projections for 12 months.  The report generated will return 12 columns of projections numbered 1 through 12 where the first column represents the month of the specified pivot date.
<!--//** '''gproj''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=gproj&f=json|sample]) (legacy){br}Gross revenue projections for 3 months.  The report generated will return 3 columns of projections using todays date as the pivot date numbered 1 through 3 where the first column represents "this month" using gross amounts.
** '''nproj''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=nproj&f=json|sample]) (legacy){br}Net revenue projections for 3 months.  The report generated will return 3 columns of projections using todays date as the pivot date numbered 1 through 3 where the first column represents "this month" using net amounts.
** '''gproj12''' (default) ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=gproj12&f=json|sample]) (legacy){br}Gross revenue projections for 12 months.  The report generated will return 12 columns of projections using todays date as the pivot date numbered 1 through 12 where the first column represents "this month" using gross amounts.
** '''nproj12''' ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=nproj12&f=json|sample]){br}Net revenue projections for 12 months.  The report generated will return 12 columns of projections using todays date as the pivot date numbered 1 through 12 where the first column represents "this month" using net amounts.//-->

((('''CS''' It's best to right click and save as the above samples.)))

====Format====

* '''json''' (default) - JSON ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=cust&f=json|sample]).{br}{br}{{{{&#123;{br}&nbsp;&nbsp;"success": true,{br}&nbsp;&nbsp;"report": "cust",{br}&nbsp;&nbsp;"data": &#91;{br}&nbsp;&nbsp;&nbsp;&nbsp;&#123;{br}&nbsp;&nbsp;&nbsp;&nbsp;"customer_guid": "...",{br}&nbsp;&nbsp;&nbsp;&nbsp;"customer": "America's Auto",{br}&nbsp;&nbsp;&nbsp;&nbsp;"owner_guid": "...",{br}&nbsp;&nbsp;&nbsp;&nbsp;"owner": "Sammy Hagar",{br}&nbsp;&nbsp;&nbsp;&nbsp;"contact_name": "",{br}&nbsp;&nbsp;&nbsp;&nbsp;"phone": "...",{br}&nbsp;&nbsp;&nbsp;&nbsp;"email": null,{br}&nbsp;&nbsp;&nbsp;&nbsp;"revenue_source": "National Agency",{br}&nbsp;&nbsp;&nbsp;&nbsp;"credit_policy": "Net 15",{br}&nbsp;&nbsp;&nbsp;&nbsp;"status": "Inactive",{br}&nbsp;&nbsp;&nbsp;&nbsp;"created": "2015-07-27"{br}&nbsp;&nbsp;&nbsp;&nbsp;&#125;{br}&nbsp;&nbsp;&#93;{br}&#125;}}}}{br}{br}(((Note: Null values are represented as "null" (not blank).))){br}{br}The '''success''' variable represents whether or not the data was able to be retrieved; ''true'' represents success, ''false'' represents failure (see below).  The ''report'' variable represents what kind of ''data'' is returned; this will match the ''type'' of data that was requested in the GET request.  The ''data'' array contains the actual report.{br}{br}{{{{&#123;{br}&nbsp;&nbsp;"success": false,{br}&nbsp;&nbsp;"message": "what happened?"{br}&#125;}}}}{br}{br}Upon a failed request, the ''success'' variable will be set to false and there will be a ''message'' variable containing the actual failure reason.{br}{br}
* '''xml''' - XML ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=cust&f=xml|sample]).
* '''html''' - HTML using tables (technically, XHTML) ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=cust&f=html|sample]).
* '''csv''' - Comma-Separated Value ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=cust&f=csv|sample]).
* '''tab''' - Tab-delimited ([http://traf.com/data/pull.aspx?x=rumple&g=fb85be35-70e2-4f32-8c07-2e6bd4d5d3a5&t=cust&f=tab|sample]).

((('''CS''' It's best to right click and save as the above samples.)))

</div>
<DIV class=transcludedpage>
  <div id="Side">{toc}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
{br}
</div>
</div>

<SCRIPT type=text/javascript> 
   var navItem = document.getElementById('ManualTab');
   navItem.className = 'active';
</SCRIPT>
RadioTraffic.com

Software and services for the radio industry.

Rumple (Technical Details)
