Show Menu

States

State/County/Region

This API calls will get you the list of state/county/region.

post/API/v4/Register/GetAdvancedContactState

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

CountryCodestring

String length: inclusive between 1 and 25

Reponse Parameters

AdvancedContactStatestring

Returned if successful List of states found. For each country, the following parameters are returned:
StateCode—Unique state code.
StateName—State name

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Register/GetAdvancedContactState

{  
  "AdvancedContactState":{  
    "request":{  
      "CountryCode":"US"
    }
  }
}
						

Sample Response:


{
	"AdvancedContactStateResponse": {
		"AdvancedContactStateResult": {
			"AdvancedContactState": {
				"AdvancedContactStateDetails": [
					{
						"StateCode": "AK",
						"StateName": "Alaska"
					},
					{
						"StateCode": "AL",
						"StateName": "Alabama"
					},
					{
						"StateCode": "AR",
						"StateName": "Arkansas"
					},
					{
						"StateCode": "AS",
						"StateName": "American Samoa"
					},
					{
						"StateCode": "AZ",
						"StateName": "Arizona"
					},
					{
						"StateCode": "CA",
						"StateName": "California"
					},
					{
						"StateCode": "CO",
						"StateName": "Colorado"
					},
					{
						"StateCode": "CT",
						"StateName": "Connecticut"
					},
					{
						"StateCode": "DC",
						"StateName": "District of Columbia"
					},
					{
						"StateCode": "DE",
						"StateName": "Delaware"
					},
					{
						"StateCode": "FL",
						"StateName": "Florida"
					},
					{
						"StateCode": "GA",
						"StateName": "Georgia"
					},
					{
						"StateCode": "GU",
						"StateName": "Guam"
					},
					{
						"StateCode": "HI",
						"StateName": "Hawaii"
					},
					{
						"StateCode": "IA",
						"StateName": "Iowa"
					},
					{
						"StateCode": "ID",
						"StateName": "Idaho"
					},
					{
						"StateCode": "IL",
						"StateName": "Illinois"
					},
					{
						"StateCode": "IN",
						"StateName": "Indiana"
					},
					{
						"StateCode": "KS",
						"StateName": "Kansas"
					},
					{
						"StateCode": "KY",
						"StateName": "Kentucky"
					},
					{
						"StateCode": "LA",
						"StateName": "Louisiana"
					},
					{
						"StateCode": "MA",
						"StateName": "Massachusetts"
					},
					{
						"StateCode": "MD",
						"StateName": "Maryland"
					},
					{
						"StateCode": "ME",
						"StateName": "Maine"
					},
					{
						"StateCode": "MI",
						"StateName": "Michigan"
					},
					{
						"StateCode": "MN",
						"StateName": "Minnesota"
					},
					{
						"StateCode": "MO",
						"StateName": "Missouri"
					},
					{
						"StateCode": "MP",
						"StateName": "Northern Mariana Islands"
					},
					{
						"StateCode": "MS",
						"StateName": "Mississippi"
					},
					{
						"StateCode": "MT",
						"StateName": "Montana"
					},
					{
						"StateCode": "NC",
						"StateName": "North Carolina"
					},
					{
						"StateCode": "ND",
						"StateName": "North Dakota"
					},
					{
						"StateCode": "NE",
						"StateName": "Nebraska"
					},
					{
						"StateCode": "NH",
						"StateName": "New Hampshire"
					},
					{
						"StateCode": "NJ",
						"StateName": "New Jersey"
					},
					{
						"StateCode": "NM",
						"StateName": "New Mexico"
					},
					{
						"StateCode": "NV",
						"StateName": "Nevada"
					},
					{
						"StateCode": "NY",
						"StateName": "New York"
					},
					{
						"StateCode": "OH",
						"StateName": "Ohio"
					},
					{
						"StateCode": "OK",
						"StateName": "Oklahoma"
					},
					{
						"StateCode": "OR",
						"StateName": "Oregon"
					},
					{
						"StateCode": "PA",
						"StateName": "Pennsylvania"
					},
					{
						"StateCode": "PR",
						"StateName": "Puerto Rico"
					},
					{
						"StateCode": "RI",
						"StateName": "Rhode Island"
					},
					{
						"StateCode": "SC",
						"StateName": "South Carolina"
					},
					{
						"StateCode": "SD",
						"StateName": "South Dakota"
					},
					{
						"StateCode": "TN",
						"StateName": "Tennessee"
					},
					{
						"StateCode": "TX",
						"StateName": "Texas"
					},
					{
						"StateCode": "UM",
						"StateName": "United States Minor Outlying Islands"
					},
					{
						"StateCode": "UT",
						"StateName": "Utah"
					},
					{
						"StateCode": "VA",
						"StateName": "Virginia"
					},
					{
						"StateCode": "VI",
						"StateName": "Virgin Islands, U.S."
					},
					{
						"StateCode": "VT",
						"StateName": "Vermont"
					},
					{
						"StateCode": "WA",
						"StateName": "Washington"
					},
					{
						"StateCode": "WI",
						"StateName": "Wisconsin"
					},
					{
						"StateCode": "WV",
						"StateName": "West Virginia"
					},
					{
						"StateCode": "WY",
						"StateName": "Wyoming"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}