| 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 |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReturnUrl | query | string | No | |
| TLSCheck | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"TLSTest":"String","ReturnUrl":"String","TLSCheck":false,"UsingRedis":true,"AppInitTime":"2024-05-02T23:24:59.1952435-04:00","ServerID":"WS-6-183-431","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-03T01:29:15.7853897-04:00","Device":"Desktop"}