Skip to content

GET all Countries

Ksenyia edited this page Feb 1, 2017 · 5 revisions

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

Resource URI

countries/{limit}/{skip}

Resource Properties

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

Response Attribute

{
   count: Integer,
   errorList: [],
   countries: [
      {
         iso2: String,
         name: String,
         _id: String,
         project_count: Integer,
         site_count: Integer,
         field_count: Integer,
         concession_count: Integer.
         transfer_by_recipient_count: Integer,
         transfer_count: Integer
      }
   ] 
}

HTTP GET

Default Request

curl -GET http://end-point-uri/countries/300/0

Response

HTTP Status Code 200

{
   count: 50,
   errorList: [],
   countries: [
     {
         iso2: "MX",
         name: "Mexico",
         _id: "56f8c98288a7024614708f34",
         project_count: 50,
         site_count: 2,
         field_count: 0,
         concession_count: 10.
         transfer_by_recipient_count: 2,
         transfer_count: 3
      },
      ...
   ]
}
Clone this wiki locally