YM REST Services

<back to all web services

EventAlias

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:/admin/events/
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/AliasReturn an event's alias.
POST/Ams/{ClientID}/Event/{EventId}/AliasSet an event's alias.
DELETE/Ams/{ClientID}/Event/{EventId}/AliasClear an event's alias.
EventAlias Parameters:
NameParameterData TypeRequiredDescription
EventIdpathintNo
AliasbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventAlias Parameters:
NameParameterData TypeRequiredDescription
EventIdpathintNo
AliasbodystringNo

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.

POST /Ams/{ClientID}/Event/{EventId}/Alias HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EventId":0,"Alias":"String","UsingRedis":true,"AppInitTime":"2024-05-03T01:46:05.4743219-04:00","ServerID":"WS-4-7-585","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:09:24.9119935-04:00","Device":"Desktop"}

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

{"EventId":0,"Alias":"String","UsingRedis":true,"AppInitTime":"2024-05-03T01:46:05.4743219-04:00","ServerID":"WS-4-7-585","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:09:24.9119935-04:00","Device":"Desktop"}