States: GetStates

Returns a list of states.

Note: You do not enter an accountId with this method.

Permissions

Anyone with a valid access token can call this method.

Request

HTTP request

GET /restapi/v2/states

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Request was successful.

GlobalStates
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

GlobalResources::GetStates

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

GlobalStates

Contains a list of supported states.

states[State]

A list of states.

State

Contains information about a state.

stateIdstring

A concatenation of the two-letter country code with the state/province/region of the office address.

Example: US-OH (for Ohio)

namestring

The name of the state. Possible values are:

  • Alberta
  • Auckland
  • New South Wales
  • Alabama
  • Alaska
  • Bay of Plenty
  • British Columbia
  • Queensland
  • South Australia
  • Manitoba
  • Canterbury
  • Arizona
  • Arkansas
  • New Brunswick
  • Tasmania
  • Hawke's Bay
  • Manawatu-Wanganui
  • Victoria
  • Newfoundland and Labrador
  • California
  • Colorado
  • Western Australia
  • Northwest Territories
  • Northland
  • Otago
  • Australian Capital Territory
  • Nova Scotia
  • Connecticut
  • Delaware
  • Nunavut
  • Northern Territory
  • Southland
  • Taranaki
  • Ontario
  • District of Columbia
  • Florida
  • Prince Edward Island
  • Waikato
  • Wellington
  • Quebec
  • Georgia
  • Guam
  • Saskatchewan
  • West Coast
  • Gisborne District
  • Yukon
  • Hawaii
  • Idaho
  • Marlborough District
  • Nelson City
  • Illinois
  • Indiana
  • Tasman District
  • Chatham Islands Territory
  • Iowa
  • Kansas
  • Kentucky
  • Louisiana
  • Maine
  • Maryland
  • Massachusetts
  • Michigan
  • Minnesota
  • Mississippi
  • Missouri
  • Montana
  • Nebraska
  • Nevada
  • New Hampshire
  • New Jersey
  • New Mexico
  • New York
  • North Carolina
  • North Dakota
  • Ohio
  • Oklahoma
  • Oregon
  • Pennsylvania
  • Puerto Rico
  • Rhode Island
  • South Carolina
  • South Dakota
  • Tennessee
  • Texas
  • US Virgin Islands
  • Utah
  • Vermont
  • Virginia
  • Washington
  • West Virginia
  • Wisconsin
  • Wyoming

}} />