YM REST Services

<back to all web services

ClientConfig

Requires Authentication
Requires any of the roles:admin, oauthadmin, member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/ClientConfigRetrieve standard client configuration information for use client-side.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ClientConfigResponse Parameters:
NameParameterData TypeRequiredDescription
LocaleformstringNo
DateFormatformstringNo
CurrencyDecimalSeparatorformstringNo
CurrencyGroupSeparatorformstringNo
CurrencySymbolformstringNo
CurrencyPositivePatternformstringNo
CurrencyNegativePatternformstringNo
SiteUrlformstringNo
SecureUrlformstringNo
MaxAlertRecipientsformintNo
CareersIDformintNo
ClientNameMobileformstringNo
QuickLinksCountformintNo

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/{ClientID}/ClientConfig HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":"2024-05-03T01:24:04.8651967-04:00","ServerID":"WS-6-134-823","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-03T02:51:16.0586488-04:00","Device":"Desktop"}