YM REST Services

<back to all web services

EventRegistrationForms

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/EventRegistrationFormsReturn a list of registration Forms.
POST/Ams/{ClientID}/EventRegistrationFormsCreate a registration form.
EventRegistrationForms Parameters:
NameParameterData TypeRequiredDescription
FormIdbodyintNo
FormNamebodystringNo
AutoApprovebodyboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventRegistrationFormsResponse Parameters:
NameParameterData TypeRequiredDescription
defaultFormIdformintNo
FormsListformList<EventRegistrationForms>No

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.

POST /Ams/{ClientID}/EventRegistrationForms HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FormId":0,"FormName":"String","AutoApprove":false,"UsingRedis":true,"AppInitTime":"2024-05-03T02:25:06.8728823-04:00","ServerID":"WS-6-183-431","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-03T03:44:53.0066918-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"defaultFormId":0,"FormsList":[{"FormId":0,"FormName":"String","AutoApprove":false,"UsingRedis":true,"AppInitTime":"2024-05-03T02:25:06.8728823-04:00","ServerID":"WS-6-183-431","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-03T03:44:53.0066918-04:00","Device":"Desktop"}],"FormId":0,"FormName":"String","AutoApprove":false,"UsingRedis":true,"AppInitTime":"2024-05-03T02:25:06.8728823-04:00","ServerID":"WS-6-183-431","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-03T03:44:53.0066918-04:00","Device":"Desktop"}