YM REST Services

<back to all web services

EventSessions

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/SessionsReturn a list of sessions linked to an event.
PUT/Ams/{ClientID}/Event/{EventId}/SessionsUpdate a given event session.
POST/Ams/{ClientID}/Event/{EventId}/SessionsCreate a new event session.
GET/Ams/{ClientID}/Event/{EventId}/Sessions/{SessionId}Return the details for a given event session.
DELETE/Ams/{ClientID}/Event/{EventId}/Sessions/{SessionId}Delete a given event session.
EventSessions Parameters:
NameParameterData TypeRequiredDescription
SessionIdpathint?No
EventIdpathintNo
DateCreatedbodyDateTimeNo
NamebodystringNo
PresenterbodystringNo
StartDatebodyDateTime?No
StartTimebodystringNo
EndDatebodyDateTime?No
EndTimebodystringNo
AllowOverlapbodyboolNo
MaxRegistrantsbodyint?No
DescriptionbodystringNo
RegistrantCountbodyint?No
NonCanceledCountbodyint?No
AllowCEUsbodybool?No
TicketsbodyList<int>No
ChargeForSessionbodybool?No
SessionGroupIdbodyint?No
SortByNamebodyboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventSessionsResponse Parameters:
NameParameterData TypeRequiredDescription
SessionsformList<EventSessions>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}/Event/{EventId}/Sessions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SessionId":0,"EventId":0,"DateCreated":"0001-01-01T00:00:00.0000000","Name":"String","Presenter":"String","StartDate":"0001-01-01T00:00:00.0000000","StartTime":"String","EndDate":"0001-01-01T00:00:00.0000000","EndTime":"String","AllowOverlap":false,"MaxRegistrants":0,"Description":"String","RegistrantCount":0,"NonCanceledCount":0,"AllowCEUs":false,"Tickets":[0],"ChargeForSession":false,"SessionGroupId":0,"SortByName":false,"UsingRedis":true,"AppInitTime":"2025-01-15T06:05:49.4554707-05:00","ServerID":"WS-6-64-014","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-01-15T08:44:22.6179110-05:00","Device":"Desktop"}

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

{"Sessions":[{"SessionId":0,"EventId":0,"DateCreated":"0001-01-01T00:00:00.0000000","Name":"String","Presenter":"String","StartDate":"0001-01-01T00:00:00.0000000","StartTime":"String","EndDate":"0001-01-01T00:00:00.0000000","EndTime":"String","AllowOverlap":false,"MaxRegistrants":0,"Description":"String","RegistrantCount":0,"NonCanceledCount":0,"AllowCEUs":false,"Tickets":[0],"ChargeForSession":false,"SessionGroupId":0,"SortByName":false,"UsingRedis":true,"AppInitTime":"2025-01-15T06:05:49.4554707-05:00","ServerID":"WS-6-64-014","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-01-15T08:44:22.6179110-05:00","Device":"Desktop"}],"SessionId":0,"EventId":0,"DateCreated":"0001-01-01T00:00:00.0000000","Name":"String","Presenter":"String","StartDate":"0001-01-01T00:00:00.0000000","StartTime":"String","EndDate":"0001-01-01T00:00:00.0000000","EndTime":"String","AllowOverlap":false,"MaxRegistrants":0,"Description":"String","RegistrantCount":0,"NonCanceledCount":0,"AllowCEUs":false,"Tickets":[0],"ChargeForSession":false,"SessionGroupId":0,"SortByName":false,"UsingRedis":true,"AppInitTime":"2025-01-15T06:05:49.4554707-05:00","ServerID":"WS-6-64-014","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-01-15T08:44:22.6179110-05:00","Device":"Desktop"}