| Requires any of the roles: | Reseller, Merchant |
| GET | /lookup/countries/{CountryCode}/states | Gets a list of states/provinces in a given country |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CountryCode | query | string | Yes | ISO 3166-1 alpha-2 country codeAllowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| States | model | List<AbbreviatedResponseItem> | No | A collection of states. |
| Pagination | model | PaginationStats | No | Pagination stats regarding the result set. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShortName | form | string | No | |
| LongName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrentPageNumber | form | int | No | |
| PageSize | form | int | No | |
| TotalRecordCount | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /lookup/countries/{CountryCode}/states HTTP/1.1
Host: syntch.simpay.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
States:
[
{
ShortName: String,
LongName: String
}
],
Pagination:
{
CurrentPageNumber: 0,
PageSize: 0,
TotalRecordCount: 0
}
}