ACacculynx
company

Get Company States

Changed on

Use this endpoint to get a list of the states supported by the current company. CountryId must be an existing country supported by the current company. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0. Default PageSize is 100. Pagination parameters are optional.

get/company-settings/location-settings/countries/{countryId}/states

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/company-settings/location-settings/countries/{countryId}/states
  • Auth
    HTTP bearer

Path parameters

countryIdstring integer required

The country's identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

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

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

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

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property to the response with the status