Loading ...

REST API: Get Countries | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Get Countries
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Countries

0 
 /5
0 (0votes)

Get Countries

GET /api/countries

Get a list of countries and their IDs. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.

Example Request

GET https://myintranet.communifire.com/api/countries

Example Response

Country JSON is returned as ResponseData. Note that some results are removed from this sample to make it shorter.

[
   {
    "CountryID": 195,
    "CountryCode": "AF",
    "CountryName": "Afghanistan",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 20,
    "CountryCode": "AL",
    "CountryName": "Albania",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 61,
    "CountryCode": "DZ",
    "CountryName": "Algeria",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 24,
    "CountryCode": "AS",
    "CountryName": "American Samoa",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 16,
    "CountryCode": "AD",
    "CountryName": "Andorra",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 196,
    "CountryCode": "AO",
    "CountryName": "Angola",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 19,
    "CountryCode": "AI",
    "CountryName": "Anguilla",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 22,
    "CountryCode": "AQ",
    "CountryName": "Antarctica",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 18,
    "CountryCode": "AG",
    "CountryName": "Antigua and Barbuda",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   },
   {
    "CountryID": 23,
    "CountryCode": "AR",
    "CountryName": "Argentina",
    "StateID": 0,
    "MetroID": 0,
    "ActiveStatus": 1,
    "TenantID": 1
   }
]

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software