YM REST Services

Countries

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/Countries	Return a list of Countries or a specific country object.	Use any of the query arguments to narrow the results.

**Countries** Parameters:
Name	Parameter	Data Type	Required	Description
countryId	query	string	No
countryCode	query	string	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**CountriesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
defaultCountry	form	Country	No
countryList	form	List<Country>	No

**Country** Parameters:
Name	Parameter	Data Type	Required
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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-15T06:36:34.5424027-05:00,
	ServerID: WS-5-212-532,
	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:10:35.7056818-05:00,
	Device: Desktop
}