Requires any of the roles: | admin, oauthadmin, member, oauthmember |
GET | /Ams/{ClientID}/CBXClientConfig | Retrieve client CBX 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 |
---|---|---|---|---|
CBXClientId | form | string | No | |
CBXIntegrationId | form | string | No | |
CBXProductId | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { CBXClientId: String, CBXIntegrationId: String, CBXProductId: String, UsingRedis: True, AppInitTime: 2025-05-08T07:51:00.9456770-04:00, ServerID: WS-5-67-264, 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-05-08T10:35:10.3177631-04:00, Device: Desktop }