acculynxCommon

Get a Particular State

Changed on

Use this endpoint to get a specific state within a specific country.

get/acculynx/countries/{countryId}/states/{stateId}

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/acculynx/countries/{countryId}/states/{stateId}
  • Auth
    HTTP bearer

Path parameters

countryIdstring integer required

The country's identifier

stateIdstring integer required

The state's identifier.

Response

OK

idinteger

The id for the state.

namestring

The name of the State.

abbreviationstring

The 2 character abbreviation for the State.

_linkstring

The URI of the State.

Example response

{
  "id": 43,
  "name": "Texas",
  "abbreviation": "TX",
  "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
}

Changes

    • breaking

      the response's property format changed from uri to no format for status

    • info

      added the optional property to the response with the status