Sunburst Chart on Payments by Project

Getting sunburst chart on payments by project data.

Resource URI

transfers?{filters}

Resource Properties

Parameter	Description
filters	Filter by company(_id), transfer_type, transfer_unit, transfer_year. Eg. transfers/50/0?company=585bbabf8bb3aa000f21230b&transfer_type=Tax&transfer_unit=USD&transfer_year=2015

Response Attribute

{
   errorList: Array,
   sunburstNew: [
       {
           children: [
                        {
                             name: String,
                             children: Array,
                             size: Integer
                        }
                     ],
           name: String,
           size: String,
           total_value: String
        }
   ],
   filters: [
       {
           company_selector: [
               { 
                   _id: String,
                   name: String 
               }
           ],
           currency_selector: [
               { 
                   _id: String,
                   name: String 
               }
           ],
           type_selector: [
               { 
                   _id: String,
                   name: String 
               }
           ],
           year_selector: [
               { 
                   _id: String,
                   name: String 
               }
           ]
       }
   ],
   total: [
       {
           currency: String,
           total_value: String
       }
   ],
   transfers: [
       {
           company: {
               _id: String,
               company_name: String
           },
           country: {
               iso2: String,
               name: String
           },
           project_site: {
               _id: String,
               name: String,
               type: String
           },
           transfer_type: String,
           transfer_unit: String,
           transfer_value: Integer,
           transfer_year: Integer
       }
   ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/transfers/50/0?transfer_unit=USD&transfer_year=2015

Response

HTTP Status Code 200

{
   errorList: [], 
   sunburstNew: [
       {
           children: [
                        {
                             name: "<b>Payment to</b><br>Indonesia<br>81956.7 Million",
                             children: [
                                 {
                                     name: "<b>Payment to</b><br>Corporate<br>6.6 Million",
                                     size: 6600000  
                                 },
                                 ...
                             ],
                             size: 100000,
                        }
                     ],
           name: "<b>Payment to</b><br>Payments<br>323298.0 Million",
           size: "323298.0",
           total_value: "323298.0"
        }
   ],
   filters: [
       {
           company_selector: [
                   {  
                       _id: "580df23b8c2de3b25f97ea49",
                       name: "Statoil Petroleum AS"
                   },
                   ...
           ],
           currency_selector: [
                   {  
                       _id: "xBBL",
                       name: "xBBL"
                   },
                   ...
           ],
           type_selector: [
                   {  
                       _id: "Dividends",
                       name: "Dividends"
                   },
                   ...
           ],
           year_selector: [
                   {  
                       _id: "2015",
                       name: "2015"
                   },
                   ...
           ],
      }
   ],
   total: [
       {
           currency: "NOK",
           total_value: "236198.3"
       },
       ...
   ],
   transfers: [
       {
           company: {
               _id: "580df23a8c2de3b25f97e98d",
               company_name: "Halmahera Ii AS"
           },
           country: {
               iso2: "ID",
               name: "Indonesia"
           },
           project_site: {
               _id: "ci-soci-xwwvo5",
               name: "Corporate",
               type: "project"
           },
           transfer_type: "License fees, rental fees, entry fees, and other considerations for licenses and/or 
                          concessions",
           transfer_unit: "NOK",
           transfer_value: 1900000,
           transfer_year: 2014
       }
   ]
}