Loading ...

REST API: Get States | Communifire Documentation

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

REST API: Get States

0 
 /5
0 (0votes)

Get States

GET /api/states

Get a list of states 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.
CountryID &CountryID=x - Used in the request URL as a query parameter

Unique ID of the country to fetch states for. See REST API: Get Countries .

Example Request

GET https://myintranet.communifire.com/api/states?CountryID=183

Example Response

State JSON is returned as ResponseData.

[
  {
    "CountryID": 183,
    "StateID": 315,
    "StateCode": "NULL",
    "StateName": "England",
    "MetroID": 0,
    "TenantID": 1
  },
  {
    "CountryID": 183,
    "StateID": 529,
    "StateCode": "IM",
    "StateName": "Isle of Man",
    "MetroID": 0,
    "TenantID": 1
  },
  {
    "CountryID": 183,
    "StateID": 318,
    "StateCode": "NULL",
    "StateName": "Northern Ireland",
    "MetroID": 0,
    "TenantID": 1
  },
  {
    "CountryID": 183,
    "StateID": 316,
    "StateCode": "NULL",
    "StateName": "Scotland",
    "MetroID": 0,
    "TenantID": 1
  },
  {
    "CountryID": 183,
    "StateID": 317,
    "StateCode": "NULL",
    "StateName": "Wales",
    "MetroID": 0,
    "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