YM REST Services

<back to all web services

EventCustomLabels

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/EventCustomLabelsReturn a list of available labels a client can customize for a given event.
PUT/Ams/{ClientID}/Event/{EventId}/EventCustomLabelsCreate the custom values of registration labels for a given event.
POST/Ams/{ClientID}/Event/{EventId}/EventCustomLabelsUpdate the custom values of registration labels for a given event.
EventCustomLabels Parameters:
NameParameterData TypeRequiredDescription
EventIdpathintNo
LabelsbodyList<EventCustomLabel>No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventCustomLabel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
MetaIdformintNo
NameformstringNo
TitleformstringNo
DefaultValueformstringNo
CustomValueformstringNo
EventCustomLabelsResponse Parameters:
NameParameterData TypeRequiredDescription
HasCustomValuesformboolNo

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}/EventCustomLabels HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EventId":0,"Labels":[{"Id":0,"MetaId":0,"Name":"String","Title":"String","DefaultValue":"String","CustomValue":"String"}],"UsingRedis":true,"AppInitTime":"2024-05-03T05:46:12.1249200-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-03T05:53:59.4873035-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"HasCustomValues":false,"EventId":0,"Labels":[{"Id":0,"MetaId":0,"Name":"String","Title":"String","DefaultValue":"String","CustomValue":"String"}],"UsingRedis":true,"AppInitTime":"2024-05-03T05:46:12.1249200-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-03T05:53:59.5029440-04:00","Device":"Desktop"}