Znode

GET states

Gets a list of states.

Request Information

» Filters

Name Description Usage
code This will filter the request by code. GET states?filter=code~{operator}~{value}
countryCode This will filter the request by country code. GET states?filter=countrycode~{operator}~{value}
name This will filter the request by name. GET states?filter=name~{operator}~{value}

» Sorting

Name Description Usage
code This will sort the response by code. GET states?sort=code
name This will sort the response by name. GET states?sort=name

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET states?page=index~{value}
size The size of the page when retrieving paged results. GET states?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "States": [
    {
      "Code": "OH",
      "CountryCode": "US",
      "Name": "OHIO"
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}