| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/Countries | Return a list of Countries or a specific country object. | Use any of the query arguments to narrow the results. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| countryId | query | string | No | |
| countryCode | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| defaultCountry | form | Country | No | |
| countryList | form | List<Country> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| countryId | form | string | No | |
| countryCode | form | string | No | |
| countryName | form | string | No | |
| numberOfLocations | form | int | No | |
| taxShipping | form | bool | No | |
| taxDues | form | bool | No | |
| locationLabel | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/Countries HTTP/1.1
Host: ws.yourmembership.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"defaultCountry":{"countryId":"String","countryCode":"String","countryName":"String","numberOfLocations":0,"taxShipping":false,"taxDues":false,"locationLabel":"String"},"countryList":[{"countryId":"String","countryCode":"String","countryName":"String","numberOfLocations":0,"taxShipping":false,"taxDues":false,"locationLabel":"String"}],"countryId":"String","countryCode":"String","UsingRedis":true,"AppInitTime":"2025-01-15T07:45:29.5231982-05:00","ServerID":"WS-4-27-804","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T09:08:26.4374895-05:00","Device":"Desktop"}