Requires any of the roles: | admin, oauthadmin, member, oauthmember |
GET | /Ams/{ClientID}/ClientConfig | Retrieve standard client configuration information for use client-side. |
---|
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 |
---|---|---|---|---|
Locale | form | string | No | |
DateFormat | form | string | No | |
CurrencyDecimalSeparator | form | string | No | |
CurrencyGroupSeparator | form | string | No | |
CurrencySymbol | form | string | No | |
CurrencyPositivePattern | form | string | No | |
CurrencyNegativePattern | form | string | No | |
SiteUrl | form | string | No | |
SecureUrl | form | string | No | |
MaxAlertRecipients | form | int | No | |
CareersID | form | int | No | |
ClientNameMobile | form | string | No | |
QuickLinksCount | form | int | 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/{ClientID}/ClientConfig HTTP/1.1 Host: ws.yourmembership.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Locale":"String","DateFormat":"String","CurrencyDecimalSeparator":"String","CurrencyGroupSeparator":"String","CurrencySymbol":"String","CurrencyPositivePattern":"String","CurrencyNegativePattern":"String","SiteUrl":"String","SecureUrl":"String","MaxAlertRecipients":0,"CareersID":0,"ClientNameMobile":"String","QuickLinksCount":0,"UsingRedis":true,"AppInitTime":"2025-01-15T08:36:36.5101848-05:00","ServerID":"WS-5-212-532","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:47:18.6618852-05:00","Device":"Desktop"}