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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"locationList":[{"locationCode":"String","locationName":"String","taxGLCode":"String","taxQBClass":"String"}],"countryId":"String","UsingRedis":true,"AppInitTime":"2025-11-16T03:55:34.3095121-05:00","ServerID":"WS-6-198-373","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-11-16T04:37:54.9126791-05:00","Device":"Desktop"}