GET all Projects

Getting list of the projects limited by 2 parameters "limit" and "skip". To get the whole list, please set limit=0 and skip=0 (Resource URI: 'projects/0/0')

Resource URI

projects/{limit}/{skip}

Resource Properties

Parameter	Description
limit	It limit the search. Default is 50. Eg. projects/50/0
skip	Offset of next page result. Default is 0. Eg. projects/50/0

Response Attribute

{
   count: Integer,
   errorList: Array,
   projects: [
     {
         _id: String,
         proj_id: String,
         proj_name: String,
         proj_established_source: 
            {
                _id: String,
                source_type_name: String,
                source_type_id: String,
                source_type_authority: String,
                source_type_examples: String,
                source_type_url_type: String,
                source_type_display: Boolean (true or false)
            },
         proj_status: 
            {
               source: String,
               _id: String,
               timestamp: Date,
               string: String
            },
         proj_commodity: Array,
         proj_country: [
           {
               iso2: String,
               name: String,
               country_aliases: Array,
               _id: String
            },
         ],
         queries: Array,
         source_type: 
            {
               p:  Boolean (true or false),
               c:  Boolean (true or false)
            },
         company_count: Integer,
         companies: [
           {
               _id: String,
               company_aliases:Array,          
               company_established_source: String,
               company_name: String,     
               countries_of_operation: Array,
               country_of_incorporation:
                  { 
                     country: String,
                     timestamp: Date                  
                  },
               open_corporates_id: String
            }          
         ],
         transfer_count: Integer,
         production_count: Integer,
         verified: String,
     }
  ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/projects/50/0

Response

HTTP Status Code 200

{
   count: 54,
   errorList:[],
   projects: [
     {
         _id: "570f7b1f935d3b3dd5dbe701",
         proj_id: "adar-gok3sd",
         proj_name: "Adargas",
         proj_established_source: 
            {
                 _id: "56e8736944442a3824141429",
                 source_type_name: "UK Mandatory payment disclosure",
                 source_type_id: "ukdis",
                 source_type_authority: "disclosure",
                 source_type_examples: "Mandatory company disclosure (eg. http://www.detnor.no/wp-content/uploads/2015/03/DETNOR-Annual-Report-2014.pdf?d5b1f2 )",
                 source_type_url_type: "Direct link to data in PDF report",
                 source_type_display: true
            },
         proj_status: 
            {
               source: "56747e060e8cc07115200ee6",
               _id: "56f8c98288a70246147090e6",
               timestamp: "2016-03-28T06:04:49.828Z",
               string: "production"
            },
         proj_commodity: [ ],
         proj_country: [
           {
                 iso2: "MX",
                 name: "Mexico",
                 _id: "56f8c98288a7024614708f34",
                 country_aliases: []
            },
         ],
         queries: [
            "570f7b1f935d3b3dd5dbe701"
         ],
         source_type: 
            {
               p:  true,
               c:  false
            },
         company_count: 1,
         companies: [
           {
               _id: "5808851f5e0ba42fc79bd560",
               company_aliases:[],          
               company_established_source: "585bb82d8bb3aa000f20b774",
               company_name: "Suncor Energy UK Limited",     
               countries_of_operation: [],
               country_of_incorporation:
                  { 
                     country: "5808851f5e0ba42fc79bd560",
                     timestamp: "2016-12-22T11:17:38.706Z"                  
                  },
               open_corporates_id: "gb/00972618"
            }          
         ],
         transfer_count: 0,
         production_count: 0,
         verified: "payment",
     },
     ...
  ]
}