YM REST Services

Ping

The following routes are available for this service:
GET	/Ams/Ping	Serves as a Ping to check on the services.	If a ReturnUrl is passed, the client is redirected to this addressed. This is necessary to address the 3rd Party Cookie issue in Safari browsers

**Ping** Parameters:
Name	Parameter	Data Type	Required	Description
ReturnUrl	query	string	No
TLSCheck	query	bool	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

**PingResponse** Parameters:
Name	Parameter	Data Type	Required	Description
TLSTest	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/Ping HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	TLSTest: String,
	ReturnUrl: String,
	TLSCheck: False,
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:20:07.3002820-04:00,
	ServerID: WS-5-155-994,
	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: 2024-05-03T08:33:20.2596301-04:00,
	Device: Desktop
}