YM REST Services

<back to all web services

Ping

The following routes are available for this service:
GET/Ams/PingServes 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:
NameParameterData TypeRequiredDescription
ReturnUrlquerystringNo
TLSCheckqueryboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PingResponse Parameters:
NameParameterData TypeRequiredDescription
TLSTestformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TLSTest":"String","ReturnUrl":"String","TLSCheck":false,"UsingRedis":true,"AppInitTime":"2024-05-03T14:13:55.3634116+00:00","ServerID":"WS-5-156-355","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-03T14:26:17.6909410+00:00","Device":"Desktop"}