YM REST Services

<back to all web services

CBXClientConfig

Requires Authentication
Requires any of the roles:admin, oauthadmin, member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/CBXClientConfigRetrieve client CBX configuration information for use client-side.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CBXClientConfigResponse Parameters:
NameParameterData TypeRequiredDescription
CBXClientIdformstringNo
CBXIntegrationIdformstringNo
CBXProductIdformstringNo

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}/CBXClientConfig HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CBXClientId":"String","CBXIntegrationId":"String","CBXProductId":"String","UsingRedis":true,"AppInitTime":"2025-04-26T12:18:58.8059544-04:00","ServerID":"WS-4-108-022","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-04-26T13:37:41.9920063-04:00","Device":"Desktop"}