Régions

GET /api/v1/regions

Liste des codes de pays ISO-3166-1 et subdivisions ISO-3166-2 supportés.

Query Parameters:  

• code – filtre les résultats par code
• search – filtre les résultats par name et name de leur pays associé

Response JSON Array of Objects:  

• code (string) – code ISO-3166 du pays ou de la subdivision
• name (string) – nom localisé du pays ou de la subdivision

Requête:

GET /api/v1/regions HTTP/1.1
Host: account.emailicious.com
Accept: application/json

Réponse:

HTTP/1.1 200 OK
Vary: Accept
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

{
    "count": 5140,
    "next": "/api/v1/regions?page=2",
    "previous": null,
    "results": [
        {
            "code": "AD",
            "name": "Andorra"
        },
        {
            "code": "AD-02",
            "name": "Canillo"
        },
        {
            "code": "AD-03",
            "name": "Encamp"
        },
        {
            "code": "AD-04",
            "name": "La Massana"
        },
        {
            "code": "AD-05",
            "name": "Ordino"
        }
    ]
}

GET /api/v1/regions/(string: code)

Détails de la région correspondant au code spécifié.

Parameters:

• code (string) – Code de pays ou de subdivision ISO-3166.

Response JSON Object:  

• code (string) – code ISO-3166 du pays ou de la subdivision
• name (string) – nom localisé du pays ou de la subdivision
• country (string) – code ISO-3166-1 du pays de la subdivision
• regions (array) – codes ISO-3166-2 et noms localisés des subdivisions du pays

Requête:

GET /api/v1/regions/CA HTTP/1.1
Host: account.emailicious.com
Accept: application/json

Réponse:

HTTP/1.1 200 OK
Vary: Accept
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

{
    "code": "CA",
    "name": "Canada",
    "country": null,
    "regions": [
        {
            "code": "CA-AB",
            "name": "Alberta"
        },
        {
            "code": "CA-BC",
            "name": "British Columbia"
        },
        {
            "code": "CA-MB",
            "name": "Manitoba"
        },
        {
            "code": "CA-NB",
            "name": "New Brunswick"
        },
        {
            "code": "CA-NL",
            "name": "Newfoundland and Labrador"
        },
        {
            "code": "CA-NS",
            "name": "Nova Scotia"
        },
        {
            "code": "CA-NT",
            "name": "Northwest Territories"
        },
        {
            "code": "CA-NU",
            "name": "Nunavut"
        },
        {
            "code": "CA-ON",
            "name": "Ontario"
        },
        {
            "code": "CA-PE",
            "name": "Prince Edward Island"
        },
        {
            "code": "CA-QC",
            "name": "Quebec"
        },
        {
            "code": "CA-SK",
            "name": "Saskatchewan"
        },
        {
            "code": "CA-YT",
            "name": "Yukon Territory"
        }
    ]
}