YM REST Services

Locations

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Locations/{countryId}	Return a list of Country locations (States, Provinces, etc).	Use any of the query arguments to limit the results.

**Locations** Parameters:
Name	Parameter	Data Type	Required	Description
countryId	path	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

**LocationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
locationList	form	List<Location>	No

**Location** Parameters:
Name	Parameter	Data Type	Required
locationCode	form	string	No
locationName	form	string	No
taxGLCode	form	string	No
taxQBClass	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}/Locations/{countryId} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	locationList: 
	[
		{
			locationCode: String,
			locationName: String,
			taxGLCode: String,
			taxQBClass: String
		}
	],
	countryId: String,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:46:04.6467430-05:00,
	ServerID: WS-6-64-014,
	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-15T08:54:48.5097943-05:00,
	Device: Desktop
}