NAV
shell ruby python csharp php

Country

The Country object

The Country object looks like this in JSON:

{
    "object": "country",
    "id": "AF",
    "name": "Afghanistan",
    "alpha3": "AFG",
    "code": 4,
    "calling_code": "93",
    "status": "active",
    "sandbox": true
}
Attribute Required Data Type
id No int
name No text (100)
alpha3 No text (3)
code No int
calling_code No text (10)
status Yes enum (active, retired)
sandbox No bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/countries" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/countries',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/countries',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/countries"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/countries');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 256,
    "results": 256,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "country",
            "id": "AF",
            "name": "Afghanistan",
            "alpha3": "AFG",
            "code": 4,
            "calling_code": "93",
            "status": "active"
        }
    ],
    "sandbox": true
}

Retrieves all Country objects.

HTTP Request

GET /countries

Parameters

None

Permissions

One of the following roles is required to call this method: