YM REST Services

<back to all web services

BrandingConfig

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/BrandingConfigRetrieve branding configuration for the given device.
PUT/Ams/{ClientID}/BrandingConfigUpdate branding configuration with the given device.
DELETE/Ams/{ClientID}/BrandingConfigDelete branding configuration for the given device.
BrandingConfig Parameters:
NameParameterData TypeRequiredDescription
OptionsbodyDictionary<string, string>No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Ams/{ClientID}/BrandingConfig HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Options":{"String":"String"},"UsingRedis":true,"AppInitTime":"2024-05-03T00:24:41.1317790-04:00","ServerID":"WS-4-69-031","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:11:12.9393025-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Options":{"String":"String"},"UsingRedis":true,"AppInitTime":"2024-05-03T00:24:41.1317790-04:00","ServerID":"WS-4-69-031","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:11:12.9393025-04:00","Device":"Desktop"}