ValueLogicChartProviderImpl Resource

These endpoints are used to retrieve chart data. As it stands the data is universal enough that it can be used for any type of chart really. But the service layer for the data was build with the Highcharts API in mind. http://api.highcharts.com/highcharts

GET /valuelogicchart/chart/getAverageSavingsLineChart

Gets the Average Savings Line Chart

Request Parameters
name type description constraints
chartStartDate query Start date for chart in yyyy-MM-dd format  
chartTotalMonths query Total months for chart int
chartTotalYears query Total years for chart int
filters query Filters to apply to search  
Response Body
media type data type description
application/json AverageSavingsLineGraph (JSON) The average savings line chart
application/xml averageSavingsLineGraph (XML)

Example

Request
GET /valuelogicchart/chart/getAverageSavingsLineChart
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "categoryLabels" : [ "...", "..." ],
  "seriesList" : [ {
    "data" : [ 12345.0, 12345.0 ],
    "name" : "..."
  }, {
    "data" : [ 12345.0, 12345.0 ],
    "name" : "..."
  } ]
}
                
              

GET /valuelogicchart/chart/getHardSavingsPieChart

Gets the Hard Savings Pie Chart

Request Parameters
name type description
filters query Filters to apply to search
Response Body
media type data type description
application/json HardSavingsPieChart (JSON) The hard savings pie chart
application/xml hardSavingsPieChart (XML)

Example

Request
GET /valuelogicchart/chart/getHardSavingsPieChart
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "airTotal" : 12345.0,
  "carTotal" : 12345.0,
  "hotelTotal" : 12345.0,
  "miscTotal" : 12345.0,
  "absoluteTotal" : 12345.0,
  "airCount" : 12345,
  "carCount" : 12345,
  "hotelCount" : 12345,
  "miscCount" : 12345
}
                
              

GET /valuelogicchart/chart/getMonthlyBreakdownGraph

Get the monthly breakdown graph

Request Parameters
name type description constraints
filters query Filters to apply to search  
startMonth query Month to start search on int
startYear query Year to start search on int
totalMonths query Total months to retrieve int
Response Body
media type data type description
application/json MonthlyBreakdownGraph (JSON) Monthly breakdown chart
application/xml monthlyBreakdownGraph (XML)

Example

Request
GET /valuelogicchart/chart/getMonthlyBreakdownGraph
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "airSeries" : {
    "points" : [ 12345.0, 12345.0 ],
    "name" : "..."
  },
  "carSeries" : {
    "points" : [ 12345.0, 12345.0 ],
    "name" : "..."
  },
  "hotelSeries" : {
    "points" : [ 12345.0, 12345.0 ],
    "name" : "..."
  },
  "miscSeries" : {
    "points" : [ 12345.0, 12345.0 ],
    "name" : "..."
  },
  "categoryLabels" : [ "...", "..." ],
  "totalSavingsSummary" : {
    "numberOfSavings" : 12345,
    "numberOfPnrs" : 12345,
    "averageSavings" : 12345.0,
    "airSavings" : 12345.0,
    "airCount" : 12345,
    "carSavings" : 12345.0,
    "carCount" : 12345,
    "hotelSavings" : 12345.0,
    "hotelCount" : 12345,
    "miscSavings" : 12345.0,
    "miscCount" : 12345,
    "voidSavings" : 12345.0,
    "voidCount" : 12345,
    "totalSavings" : 12345.0,
    "date" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }
}