API Functions
Learn about the following API calls:
- GetEventTypes
- GetLocations
- GetCalendars
- GetCalendar
- GetGroupings
- GetEvents
- GetFeaturedEvents
- GetEvent
- GetUDQs
- GetComments
- AddEvent (Requires Advanced API Option)
- AddEventWithMultipleDates (Requires Advanced API Option)
- UpdateEvent (Requires Advanced API Option)
- UpdateEventDate (Requires Advanced API Option)
GetEventTypes
This API returns a list of event types.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
Response Elements
Name |
Description |
Type |
---|---|---|
Name |
Location Name |
String |
EventTypeID |
Event Type ID |
Integer |
Color |
Event Type Color |
String |
Sample Code
private void GetEventTypes()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetEventTypes("username", "pwd"));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<EventTypes>
<Data>
<EventTypeID>169</EventTypeID>
<Name>Academic</Name>
<Color>#CCCC66</Color>
</Data>
<Data>
<EventTypeID>171</EventTypeID>
<Name>Athletic</Name>
<Color>#FF3300</Color>
</Data>
</EventTypes>
GetLocations
This API returns a list of locations.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
Response Elements
Name |
Description |
Type |
---|---|---|
Name |
Location Name |
String |
LocationID |
Location ID |
Integer |
Url |
Location Url |
String |
Sample Code
private void GetLocations()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetLocations("username", "pwd"));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Locations>
<LocationID>15</LocationID>
<Name>10th Floor</Name>
<Url>http://maps.google.com/</Url>
</Data>
<Data>
<LocationID>11</LocationID>
<Name>11th Floor</Name>
<Url>http://maps.google.com/</Url>
</Data> </Locations>
GetCalendars
This API returns a list of calendars.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
Response Elements
Name |
Description |
Type |
---|---|---|
Name |
Calendar Name |
String |
CalendarID |
Calendar ID |
Integer |
Sample Code
private void GetCalendars()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService();
svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetCalendars("username", "pwd"));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Calendars>
<Data>
<CalendarID>134</CalendarID>
<Name>Alumni</Name>
</Data>
<CalendarID>3</CalendarID>
<Name>Athletics</Name>
</Data> </Calendars>
GetCalendar
This API returns calendar information for a specific calendar.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
CalendarID |
MC Calendar ID |
Integer |
Response Elements
Name |
Description |
Type |
---|---|---|
Name |
Calendar Name |
String |
CalendarID |
Calendar ID |
Integer |
Description |
Calendar Description |
String |
AdminName |
Calendar Admin Name |
String |
AdminEmail |
Calendar Admin Email |
String |
ApprovalEmail |
Calendar Approval Email |
|
IsPrivate |
Calendar is set as private |
Boolean |
IsActive |
Calendar is active |
Boolean |
ShowCancelledEvents |
Calendar shows canceled events |
Boolean |
DefaultViewID |
Calendar View 0=Daily, 1=Weekly, 3=Monthly, 4=Yearly |
Integer |
CalendarFormatID |
Calendar Format 1 = List, 2 = Grid |
Integer |
GroupingID |
Calendar GroupingID |
Integer |
ShowWeekends |
Calendar shows weekends |
Boolean |
StartWeekOn |
Calendar Starts On 0=Sun,1=Mon,2=Tue,3=Wed,4=Thu,5=Fri,6=Sat |
Integer |
AllowPublicSubmission |
Calendar allows public submission |
Boolean |
ContactInfoPublic |
Show Calendar contact info |
Boolean |
Subscription |
Calendar Subscription 0=Off, 1=Authenticated Users, 2=All Users |
Integer |
ListTypeID |
Calendar List Type Format 1=Condensed, 2=Standard, 3=Detailed |
Integer |
Sample Code
private void GetCalendar()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService();
svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetCalendar("username", "pwd", 1));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Calendar>
<Data>
<Name>Cycling Club</Name>
<CalendarID>126</CalendarID>
<Description />
<AdminName>Brad</AdminName>
<AdminEmail> email@yourcompany.com </AdminEmail>
<ApprovalEmail>email@yourcompany.com</ApprovalEmail>
<IsPrivate>false</IsPrivate>
<IsActive>true</IsActive>
<ShowCancelledEvents>false</ShowCancelledEvents>
<DefaultViewID>2</DefaultViewID>
<CalendarFormatID>1</CalendarFormatID>
<GroupingID>3</GroupingID>
<ShowWeekends>true</ShowWeekends>
<StartWeekOn>0</StartWeekOn>
<AllowPublicSubmission>true</AllowPublicSubmission>
<ContactInfoPublic>true</ContactInfoPublic>
<Subscription>2</Subscription>
<ListTypeID>3</ListTypeID>
</Data> </Calendar>
GetGroupings
This API returns a list of group IDs.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
Response Elements
Name |
Description |
Type |
---|---|---|
Name |
Grouping Name |
String |
GroupingID |
Grouping ID |
Integer |
Sample Code
private void GetGroupings()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService();
svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetGroupings("username", "pwd"));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Groupings>
<GroupingID>18</GroupingID>
<Name>Administration</Name>
</Data>
<Data>
<GroupingID>15</GroupingID>
<Name>Conference Center</Name>
</Data> </Groupings>
GetEvents
This API returns a list of events.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
StartDate |
Event Start Date |
DateTime |
EndDate |
Event End Date |
DateTime |
EventName |
Event Title (searches partial) |
String |
Location |
Event Location (Searches partial) |
String |
Calendars |
Calendars to search. (null value = all calendars) |
Integer Array |
EventTypes |
EventTypes to search. (null value = all eventtypes) |
Integer Array |
Response Elements
Name |
Description |
Type |
---|---|---|
EventDetailID |
Event Detail ID |
Integer |
EventID |
Event ID |
Integer |
Title |
Event Title |
String |
Description |
Event Description |
String |
Location |
Event Location |
String |
LocationUrl |
Event Location Url |
String |
Canceled |
Event Canceled |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Priority |
Event priority 1=High, 2=Medium, 3=Low |
Integer |
EventDate |
Event Date |
DateTime |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnds |
Time Event Ends |
DateTime |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsTimedEvent |
Is Event a timed event |
Boolean |
EventTypeID |
Event Type ID |
Integer |
EventTypeName |
Event Type Name |
String |
Contactname |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
IsReOccurring |
Event has multiple dates |
Boolean |
IsOnMultipleCalendars |
Event is on multiple calendars |
Boolean |
BookingID |
EMS Booking ID |
Integer |
ReservationID |
EMS Reservation ID |
Integer |
ConnectorID |
MC Connector ID |
Integer |
HideContactName |
Hide Contact Name |
Boolean |
HideContactEmail |
Hide Contact Email |
Boolean |
HideContactPhone |
Hide Contact Phone |
Boolean |
CustomFieldLabel1 |
Custom Field Label 1 |
String |
CustomFieldDescription1 |
Custom Field Description 1 |
String |
CustomUrl1 |
Custom Url 1 |
String |
CustomFieldLabel2 |
Custom Field Label 2 |
String |
CustomFieldDescription2 |
Custom Field Description 2 |
String |
CustomUrl2 |
Custom Url 2 |
String |
EventUpdatedBy |
Last Event Updated By |
String |
EventUpdatedDate |
Last Event Updated Date |
DateTime |
EventDetailUpdatedBy |
Last Event Detail Updated By |
String |
EventDetailUpdatedDate |
Last Event Detail Updated Date |
DateTime |
Sample Code
private void GetEvents()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
svcMCAPI.ArrayOfInt calendars = new svcMCAPI.ArrayOfInt(); calendars.Add(12); calendars.Add(14);
svcMCAPI.ArrayOfInt eventTypes = new svcMCAPI.ArrayOfInt(); eventTypes.Add(4);
StringReader sr = new StringReader(svc.GetEvents ("username", "pwd", DateTime.Now.AddDays(-5), DateTime.Now.AddDays(5), "", "", calendars, eventTypes));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Events>
<Data>
<EventDetailID>155609</EventDetailID>
<EventID>23173</EventID>
<Title>Test Event (TT) 240 month recurrence</Title>
<Description />
<Location>RM B</Location>
<Canceled>false</Canceled>
<NoEndTime>false</NoEndTime>
<Priority>2</Priority>
<EventDate>2011-04-01T00:00:00-06:00</EventDate>
<TimeEventStart>2011-04-01T10:00:00-06:00</TimeEventStart>
<TimeEventEnd>2011-04-01T11:00:00-06:00</TimeEventEnd>
<IsAllDayEvent>false</IsAllDayEvent>
<IsTimedEvent>true</IsTimedEvent>
<EventTypeID>111</EventTypeID>
<EventTypeName>Conference</EventTypeName>
<ContactName>Tester 1</ContactName>
<ContactEmail>test@dea.com</ContactEmail>
<IsReOccurring>true</IsReOccurring>
<IsOnMultipleCalendars>false</IsOnMultipleCalendars>
<BookingID>61157</BookingID>
<ReservationID>3609</ReservationID>
<ConnectorID>0</ConnectorID>
<HideContactName>false</HideContactName>
<HideContactEmail>false</HideContactEmail>
<HideContactPhone>false</HideContactPhone>
<EventUpdatedBy>Connector Service</EventUpdatedBy>
<EventUpdatedDate>2018-06-03T16:34:34.15-06:00</EventUpdatedDate>
<EventDetailUpdatedBy>dbo</EventDetailUpdatedBy>
<EventDetailUpdatedDate>2018-06-03T16:34:34.167-06:00</EventDetailUpdatedDate> </Data>
</Events>
GetEvent
This API returns event information for a specific event date.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventDetailID |
Event Detail ID for the specific event date |
Integer |
Response Elements
Name |
Description |
Type |
---|---|---|
EventDetailID |
Event Detail ID |
Integer |
EventID |
Event ID |
Integer |
Title |
Event Title |
String |
TitleURL |
Event Title Url |
String |
Description |
Event Description |
String |
Department |
Event Department |
String |
Location |
Event Location |
String |
LocationUrl |
Event Location Url |
String |
Canceled |
Event Canceled |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Priority |
Event priority 1=High, 2=Medium, 3=Low |
Interger |
EventDate |
Event Date |
DateTime |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnd |
Time Event Ends |
DateTime |
PostDate |
Date Event Posts on the calendar |
DateTime |
TimezoneID |
TimezoneID |
Integer |
TimezoneAbbr |
Timezone abbreviation |
String |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsTimedEvent |
Is Event a timed event |
Boolean |
CalendarName |
Calendar Name |
String |
EventTypeID |
Event Type ID |
Integer |
EventTypeName |
Event Type Name |
String |
EventTypeColor |
Color of the Event Type |
String |
ContactName |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
IsReOccurring |
Event has multiple dates |
Boolean |
IsOnMultipleCalendars |
Event is on multiple calendars |
Boolean |
BookingID |
EMS Booking ID |
Integer |
ReservationID |
EMS Reservation ID |
Integer |
ConnectorID |
MC Connector ID |
Integer |
HideContactName |
Hide Contact Name |
Boolean |
HideContactEmail |
Hide Contact Email |
Boolean |
HideContactPhone |
Hide Contact Phone |
Boolean |
CustomFieldLabel1 |
Custom Field Label 1 |
String |
CustomFieldDescription1 |
Custom Field Description 1 |
String |
CustomUrl1 |
Custom Url 1 |
String |
CustomFieldLabel2 |
Custom Field Label 2 |
String |
CustomFieldDescription2 |
Custom Field Description 2 |
String |
CustomUrl2 |
Custom Url 2 |
String |
EventUpdatedBy |
Last Event Updated By |
String |
EventUpdatedDate |
Last Event Updated Date |
DateTime |
EventDetailUpdatedBy |
Last Event Detail Updated By |
String |
EventDetailUpdatedDate |
Last Event Detail Updated Date |
DateTime |
ImageId |
Event Image ID |
Integer |
FileExtension |
Event Image file extension |
String |
ImageName |
Event Image Name |
String |
Image |
Event Image |
Image Bytes |
Sample Code
private void GetEvent()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService();
svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
int eventDetailId = 126;
StringReader sr = new StringReader(svc.GetEvents ("username", "pwd”, eventDetailId));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Event>
<Data>
<EventDetailID>155609</EventDetailID>
<EventID>23173</EventID>
<Title>Test Event (TT) 240 month recurrence</Title>
<TitleUrl />
<Description />
<Department>Test Group</Department>
<Location>RM B</Location>
<Canceled>false</Canceled>
<NoEndTime>false</NoEndTime>
<StartDate>2011-04-01T00:00:00-06:00</StartDate>
<Priority>2</Priority>
<TimeEventStart>2011-04-01T10:00:00-06:00</TimeEventStart>
<TimeEventEnd>2011-04-01T11:00:00-06:00</TimeEventEnd>
<IsAllDayEvent>false</IsAllDayEvent>
<IsTimedEvent>true</IsTimedEvent>
<TimeZoneID>68</TimeZoneID>
<ContactName>Tester 1</ContactName>
<ContactEmail>test@dea.com</ContactEmail>
<ContactPhone>0123456789</ContactPhone>
<IsOnMultipleCalendars>false</IsOnMultipleCalendars>
<IsReOccurring>true</IsReOccurring>
<CustomFieldLabel1 />
<CustomFieldDescription1 />
<CustomURL1 />
<CustomFieldLabel2 />
<CustomFieldDescription2 />
<CustomURL2 />
<EventTypeID>111</EventTypeID>
<EventTypeName>Conference</EventTypeName>
<EventTypeColor>#CC00CC</EventTypeColor>
<BookingID>61157</BookingID>
<ReservationID>3609</ReservationID>
<Priority1>2</Priority1>
<HideContactName>false</HideContactName>
<HideContactEmail>false</HideContactEmail>
<HideContactPhone>false</HideContactPhone>
<CalendarName>Cycling Club</CalendarName>
<PostDate>2010-06-03T16:34:34.15-06:00</PostDate>
<TimezoneAbbr>MT</TimezoneAbbr>
<EventUpdatedBy>Connector Service</EventUpdatedBy>
<EventUpdatedDate>2010-06-03T16:34:34.15-06:00</EventUpdatedDate>
<EventDetailUpdatedBy>dbo</EventDetailUpdatedBy>
<EventDetailUpdatedDate>2010-06-03T16:34:34.167-06:00</EventDetailUpdatedDate> <ImageId>0</ImageId>
<FileExtension />
<ImageName>Image</ImageName>
</Data>
</Event>
GetFeaturedEvents
This API returns a list of events.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
StartDate |
Event Start Date |
DateTime |
EndDate |
Event End Date |
DateTime |
EventName |
Event Title (searches partial) |
String |
Location |
Event Location (Searches partial) |
String |
Calendars |
Calendars to search. (null value = all calendars) |
Integer Array |
EventTypes |
EventTypes to search. (null value = all event types) |
Integer Array |
UDQAnswer |
UDQ Answer (text or list) |
String |
Response Elements
Name |
Description |
Type |
---|---|---|
EventDetailID |
Event Detail ID |
Integer |
EventID |
Event ID |
Integer |
Title |
Event Title |
String |
Description |
Event Description |
String |
Location |
Event Location |
String |
LocationUrl |
Event Location Url |
String |
Canceled |
Event Canceled |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Priority |
Event priority 1=High, 2=Medium, 3=Low |
Integer |
EventDate |
Event Date |
DateTime |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnds |
Time Event Ends |
DateTime |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsTimedEvent |
Is Event a timed event |
Boolean |
EventTypeID |
Event Type ID |
Integer |
EventTypeName |
Event Type Name |
String |
ContactName |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
ContactPhone |
Event Contact Phone |
String |
IsReOccurring |
Event has multiple dates |
Boolean |
IsOnMultipleCalendars |
Event is on multiple calendars |
Boolean |
BookingID |
EMS Booking ID |
Integer |
ReservationID |
EMS Reservation ID |
Integer |
ConnectorID |
MC Connector ID |
Integer |
HideContactName |
Hide Contact Name |
Boolean |
HideContactEmail |
Hide Contact Email |
Boolean |
HideContactPhone |
Hide Contact Phone |
Boolean |
CustomFieldLabel1 |
Custom Field Label 1 |
String |
CustomFieldDescription1 |
Custom Field Description 1 |
String |
CustomUrl1 |
Custom Url 1 |
String |
CustomFieldLabel2 |
Custom Field Label 2 |
String |
CustomFieldDescription2 |
Custom Field Description 2 |
String |
CustomUrl2 |
Custom Url 2 |
String |
EventUpdatedBy |
Last Event Updated By |
String |
EventUpdatedDate |
Last Event Updated Date |
DateTime |
EventDetailUpdatedBy |
Last Event Detail Updated By |
String |
EventDetailUpdatedDate |
Last Event Detail Updated Date |
DateTime |
Sample Code
private void GetFeaturedEvents()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
svcMCAPI.ArrayOfInt calendars = new svcMCAPI.ArrayOfInt(); calendars.Add(12); calendars.Add(14);
svcMCAPI.ArrayOfInt eventTypes = new svcMCAPI.ArrayOfInt(); eventTypes.Add(4);
StringReader sr = new StringReader(svc.GetFeaturedsEvents("username", "pwd", DateTime.Now.AddDays(-5), DateTime.Now.AddDays(5), "", "", calendars, eventTypes));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Events>
<Data>
<EventDetailID>155609</EventDetailID>
<EventID>23173</EventID>
<Title>Test Event (TT) 240 month recurrence</Title>
<Description />
<Location>RM B</Location>
<Canceled>false</Canceled>
<NoEndTime>false</NoEndTime>
<Priority>2</Priority>
<EventDate>2011-04-01T00:00:00</EventDate>
<TimeEventStart>2011-04-01T10:00:00</TimeEventStart>
<TimeEventEnd>2011-04-01T11:00:00</TimeEventEnd>
<IsAllDayEvent>false</IsAllDayEvent>
<IsTimedEvent>true</IsTimedEvent>
<EventTypeID>111</EventTypeID>
<EventTypeName>Conference</EventTypeName>
<ContactName>Tester 1</ContactName>
<ContactEmail>test@dea.com</ContactEmail>
<IsReOccurring>true</IsReOccurring>
<IsOnMultipleCalendars>false</IsOnMultipleCalendars>
<BookingID>61157</BookingID>
<ReservationID>3609</ReservationID>
<ConnectorID>0</ConnectorID>
<HideContactName>false</HideContactName>
<HideContactEmail>false</HideContactEmail>
<HideContactPhone>false</HideContactPhone>
<EventUpdatedBy>Connector Service</EventUpdatedBy>
<EventUpdatedDate>2010-06-03T16:34:34.15</EventUpdatedDate>
<EventDetailUpdatedBy>dbo</EventDetailUpdatedBy>
<EventDetailUpdatedDate>2010-06-03T16:34:34.167</EventDetailUpdatedDate>
</Data>
</Events>
GetEvent
This API returns event information for a specific event date.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventDetailID |
Event Detail ID for the specific event date |
Integer |
Response Elements
Name |
Description |
Type |
---|---|---|
EventDetailID |
Event Detail ID |
Integer |
EventID |
Event ID |
Integer |
Title |
Event Title |
String |
TitleURL |
Event Title Url |
String |
Description |
Event Description |
String |
Department |
Event Department |
String |
Location |
Event Location |
String |
LocationUrl |
Event Location Url |
String |
Canceled |
Event Canceled |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Priority |
Event priority 1=High, 2=Medium, 3=Low |
Integer |
EventDate |
Event Date |
DateTime |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnd |
Time Event Ends |
DateTime |
PostDate |
Date Event Posts on the calendar |
DateTime |
TimezoneID |
TimezoneID |
Integer |
TimezoneAbbr |
Timezone abbreviation |
String |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsTimedEvent |
Is Event a timed event |
Boolean |
CalendarName |
Calendar Name |
String |
EventTypeID |
Event Type ID |
Integer |
EventTypeName |
Event Type Name |
String |
EventTypeColor |
Color of the Event Type |
String |
ContactName |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
ContactPhone |
Event Contact Phone |
String |
IsReOccurring |
Event has multiple dates |
Boolean |
IsOnMultipleCalendars |
Event is on multiple calendars |
Boolean |
BookingID |
EMS Booking ID |
Integer |
ReservationID |
EMS Reservation ID |
Integer |
ConnectorID |
MC Connector ID |
Integer |
HideContactName |
Hide Contact Name |
Boolean |
HideContactEmail |
Hide Contact Email |
Boolean |
HideContactPhone |
Hide Contact Phone |
Boolean |
CustomFieldLabel1 |
Custom Field Label 1 |
String |
CustomFieldDescription1 |
Custom Field Description 1 |
String |
CustomUrl1 |
Custom Url 1 |
String |
CustomFieldLabel2 |
Custom Field Label 2 |
String |
CustomFieldDescription2 |
Custom Field Description 2 |
String |
CustomUrl2 |
Custom Url 2 |
String |
EventUpdatedBy |
Last Event Updated By |
String |
EventUpdatedDate |
Last Event Updated Date |
DateTime |
EventDetailUpdatedBy |
Last Event Detail Updated By |
String |
EventDetailUpdatedDate |
Last Event Detail Updated Date |
DateTime |
ImageId |
Event Image ID |
Integer |
FileExtension |
Event Image file extension |
String |
ImageName |
Event Image Name |
String |
Image |
Event Image |
Base64String |
Sample Code
private void GetEvent()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
int eventDetailId = 126;
StringReader sr = new StringReader(svc.GetEvents("username", "pwd”, eventDetailId));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Event>
<Data>
<EventDetailID>155609</EventDetailID>
<EventID>23173</EventID>
<Title>Test Event (TT) 240 month recurrence</Title>
<TitleUrl />
<Description />
<Department>Test Group</Department>
<Location>RM B</Location>
<Canceled>false</Canceled>
<NoEndTime>false</NoEndTime>
<StartDate>2011-04-01T00:00:00</StartDate>
<Priority>2</Priority>
<TimeEventStart>2011-04-01T10:00:00</TimeEventStart>
<TimeEventEnd>2011-04-01T11:00:00</TimeEventEnd>
<IsAllDayEvent>false</IsAllDayEvent>
<IsTimedEvent>true</IsTimedEvent>
<TimeZoneID>68</TimeZoneID>
<ContactName>Tester 1</ContactName>
<ContactEmail>test@dea.com</ContactEmail>
<ContactPhone>0123456789</ContactPhone>
<IsOnMultipleCalendars>false</IsOnMultipleCalendars>
<IsReOccurring>true</IsReOccurring>
<CustomFieldLabel1 />
<CustomFieldDescription1 />
<CustomURL1 />
<CustomFieldLabel2 />
<CustomFieldDescription2 />
<CustomURL2 />
<EventTypeID>111</EventTypeID>
<EventTypeName>Conference</EventTypeName>
<EventTypeColor>#CC00CC</EventTypeColor>
<BookingID>61157</BookingID>
<ReservationID>3609</ReservationID>
<Priority1>2</Priority1>
<HideContactName>false</HideContactName>
<HideContactEmail>false</HideContactEmail>
<HideContactPhone>false</HideContactPhone>
<CalendarName>Cycling Club</CalendarName>
<PostDate>2010-06-03T16:34:34.15</PostDate>
<TimezoneAbbr>MT</TimezoneAbbr>
<EventUpdatedBy>Connector Service</EventUpdatedBy>
<EventUpdatedDate>2010-06-03T16:34:34.15</EventUpdatedDate>
<EventDetailUpdatedBy>dbo</EventDetailUpdatedBy>
<EventDetailUpdatedDate>2010-06-03T16:34:34.167</EventDetailUpdatedDate>
<ImageId>0</ImageId>
<FileExtension />
<ImageName>Image</ImageName>
</Data>
</Event>
GetUdqs
This API returns user defined question information for a specific event.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventID |
MC Event ID |
Integer |
Response Elements
Name |
Description |
Type |
---|---|---|
UDQID |
User Defined Question ID |
Integer |
PromptText |
User Defined Question Prompt |
String |
Answer |
User Defined Question Answer |
String |
Sequence |
User Defined Question Sequence |
Integer |
Sample Code
private void GetUdqs()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetUdqs("username", "pwd", 1));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Udqs>
<Data>
<UDQID>126</UDQID>
<PromptText>How will your organization pay for this event?</PromptText>
<Answer>Cash</Answer>
<Sequence>1</Sequence>
</Data> </Udqs>
GetComments
This API returns EMS comments for a specific event.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventID |
MC Event ID |
Integer |
ReservationID |
EMS Reservation ID |
Integer |
BookingID |
EMS Booking ID |
Integer |
Response Elements
Name |
Description |
Type |
---|---|---|
ID |
EMS Comment ID |
Integer |
Notes |
EMS Comment Notes |
String |
CommentType |
EMS Comment Type |
String |
NoteType |
Returns value of ‘User Notes’, ‘Reservation Notes’ or ‘Booking Notes’ |
String |
Sample Code
private void GetComments()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService();
svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.GetComments("username", "pwd", 1,25, 482));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Comments>
<Data>
<ID>1</ID>
<Notes>details…</Notes>
<CommentType>Event Details</CommentType>
<NoteType>Reservation Notes</ NoteType >
</Data> </Comments>
AddEvent (Requires Advanced API Option)
This API allows you to add an Event.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventDate |
Event Start Date |
DateTime |
Calendars |
Calendar Ids |
Integer Array |
Title |
Event Name |
String |
TitleURL |
Event Title URL |
String |
Description |
Event Description |
String |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnd |
Time Event Ends |
DateTime |
Location |
Event Location |
String |
LocationURL |
Event Location URL |
String |
ContactName |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
ContactPhone |
Event Contact Phone |
String |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsUntimed |
Is Event a timed event |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Canceled |
Event Canceled |
Boolean |
CustomFieldLabel1 |
Event Custom Field Label 1 |
String |
CustomFieldDescription1 |
Event Custom Field Description 1 |
String |
CustomFieldUrl1 |
Event Custom Field Url 1 |
String |
CustomFieldLabel2 |
Event Custom Field Label 2 |
String |
CustomFieldDescription2 |
Event Custom Field Description 2 |
String |
CustomFieldUrl2 |
Event Custom Field Url 2 |
String |
EventTypeID |
EventTypeID |
Integer |
Department |
Event Department |
String |
HideContactName |
Hide Event Contact Name |
Boolean |
HideContactEmail |
Hide Event Contact Email |
Boolean |
HideContactPhone |
Hide Event Contact Phone |
Boolean |
Response Elements
Name |
Description |
Type |
---|---|---|
EventID |
EventID |
Integer |
EventDetailID |
Event Detail ID |
Integer |
Sample Code
private void AddEvent()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
int[] cals = new int[] { 3, 126 };
StringReader sr = new StringReader(svc.AddEvent("username", "pwd", “1/1/1900”, cals,
"Test API Event","", "This is a test api description", “1/1/1900 00:00”, “1/1/1900 00:00”, "Denver", "http://www.dea.com", "Contact Name", "Contact Email", "", false, false, false, false,"","","","","","",-1, "", false, false, true));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Event>
<Data>
<EventDetailID>155609</EventDetailID>
<EventID>23173</EventID>
</Data>
</Event>
AddEventWithMultipleDates (Requires Advanced API Option)
This API allows you to add an Event.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
Dates |
List of Event Dates |
DateTime Array |
Calendars |
Calendar Ids |
Integer Array |
Title |
Event Name |
String |
TitleURL |
Event Title URL |
String |
Description |
Event Description |
String |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnd |
Time Event Ends |
DateTime |
Location |
Event Location |
String |
LocationURL |
Event Location URL |
String |
ContactName |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
ContactPhone |
Event Contact Phone |
String |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsUntimed |
Is Event a timed event |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Canceled |
Event Canceled |
Boolean |
CustomFieldLabel1 |
Event Custom Field Label 1 |
String |
CustomFieldDescription1 |
Event Custom Field Description 1 |
String |
CustomFieldUrl1 |
Event Custom Field Url 1 |
String |
CustomFieldLabel2 |
Event Custom Field Label 2 |
String |
CustomFieldDescription2 |
Event Custom Field Description 2 |
String |
CustomFieldUrl2 |
Event Custom Field Url 2 |
String |
EventTypeID |
EventTypeID |
Integer |
Department |
Event Department |
String |
HideContactName |
Hide Event Contact Name |
Boolean |
HideContactEmail |
Hide Event Contact Email |
Boolean |
HideContactPhone |
Hide Event Contact Phone |
Boolean |
Response Elements
Name |
Description |
Type |
---|---|---|
EventID |
EventID |
Integer |
EventDetailID |
Event Detail ID |
Integer |
Sample Code
private void AddEventWithMultipleDates()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
DateTime[] dates = new DateTime[] { DateTime.Now, DateTime.Now.AddDays(1) }; int[] cals = new int[] { 3, 126 };
StringReader sr = new StringReader(svc.AddEventWithMultipleDates("username", "pwd", dates, cals, "Test API Event","", "This is a test api description", “1/1/1900 00:00”, “1/1/1900 00:00”, "Denver", "http://www.dea.com", "Contact Name", "Contact Email", "", false, false, false, false,"","","","","","",-1, "", false, false, true));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Event>
<Data>
<EventID>23173</EventID>
</Data>
</Event>
UpdateEvent (Requires Advanced API Option)
This API allows you to add an Event.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventID |
EventID |
Integer |
EventDate |
Event Start Date |
DateTime |
Calendars |
Calendar Ids |
Integer Array |
Title |
Event Name |
String |
TitleURL |
Event Title URL |
String |
Description |
Event Description |
String |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnd |
Time Event Ends |
DateTime |
Location |
Event Location |
String |
LocationURL |
Event Location URL |
String |
ContactName |
Event Contact Name |
String |
ContactEmail |
Event Contact Email |
String |
ContactPhone |
Event Contact Phone |
String |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsUntimed |
Is Event a timed event |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
Canceled |
Event Cancelled |
Boolean |
CustomFieldLabel1 |
Event Custom Field Label 1 |
String |
CustomFieldDescription1 |
Event Custom Field Description 1 |
String |
CustomFieldUrl1 |
Event Custom Field Url 1 |
String |
CustomFieldLabel2 |
Event Custom Field Label 2 |
String |
CustomFieldDescription2 |
Event Custom Field Description 2 |
String |
CustomFieldUrl2 |
Event Custom Field Url 2 |
String |
EventTypeID |
EventTypeID |
Integer |
Department |
Event Department |
String |
HideContactName |
Hide Event Contact Name |
Boolean |
HideContactEmail |
Hide Event Contact Email |
Boolean |
HideContactPhone |
Hide Event Contact Phone |
Boolean |
Response Elements
Name |
Description |
Type |
---|---|---|
Message |
“Success!” or error |
String |
Sample Code
private void UpdateEvent()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
int[] cals = new int[] { 3, 126 };
StringReader sr = new StringReader(svc.AddEvent("username", "pwd", eventId, “1/1/1900”, cals, "Test API Event","", "This is a test api description", “1/1/1900 00:00”, “1/1/1900 00:00”, "Denver", "http://www.dea.com", "Contact Name", "Contact Email", "", false, false, false, false,"","","","","","",-1, "", false, false, true));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Messages>
<Message>
<Message>Success!</Message>
</Message>
</Messages>
UpdateEventDate (Requires Advanced API Option)
This API allows you to add an Event.
Request Parameters
Name |
Description |
Type |
---|---|---|
UserName |
MC User Name |
String |
Password |
MC User Password |
String |
EventDetailID |
EventDetailID |
Integer |
EventDate |
Event Start Date |
DateTime |
Title |
Event Name |
String |
TitleURL |
Event Title URL |
String |
Description |
Event Description |
String |
TimeEventStart |
Time Event Starts |
DateTime |
TimeEventEnd |
Time Event Ends |
DateTime |
Location |
Event Location |
String |
LocationURL |
Event Location URL |
String |
IsAllDayEvent |
Is Event All Day |
Boolean |
IsUntimed |
Is Event a timed event |
Boolean |
NoEndTime |
Event has no end time |
Boolean |
CustomFieldLabel1 |
Event Custom Field Label 1 |
String |
CustomFieldDescription1 |
Event Custom Field Description 1 |
String |
CustomFieldUrl1 |
Event Custom Field Url 1 |
String |
CustomFieldLabel2 |
Event Custom Field Label 2 |
String |
CustomFieldDescription2 |
Event Custom Field Description 2 |
String |
CustomFieldUrl2 |
Event Custom Field Url 2 |
String |
EventTypeID |
EventTypeID |
Integer |
Response Elements
Name |
Description |
Type |
---|---|---|
Message |
“Success!” or error |
String |
Sample Code
private void UpdateEventDate()
{
MCAPI.MCAPIService svc = new MCAPI.MCAPIService(); svc.Url = "http://yourserver/MCAPI/MCAPIService.asmx?WSDL";
StringReader sr = new StringReader(svc.AddEventDate("username", "pwd",
eventDetailId, “1/1/1900”, "Test API Event","", "This is a test api description", “1/1/1900
00:00”, “1/1/1900 00:00”, "Denver", "http://www.dea.com", false, false, false, false,"","","","","","",-1));
DataSet ds = new DataSet();
System.Xml.XmlDocument doc = new System.Xml.XmlDocument(); doc.LoadXml(sr.ReadToEnd());
ds.ReadXml(new System.Xml.XmlNodeReader(doc));
}
Example Response
<Messages>
<Message>
<Message>Success!</Message>
</Message>
</Messages>