Cdn Mobile API

<back to all web services

EventCalendarRequest

Cdn.MobileApi

The following routes are available for this service:
GET/EventCalendar
EventCalendarRequest Parameters:
NameParameterData TypeRequiredDescription
EventDefinitionIdquerylongNo
EventStartquerystringNo
EventEndquerystringNo
IsCancelledqueryboolNo
IsFutureOnlyqueryboolNo
EventTypequerystringNo
GetAllqueryboolNo
SkipqueryintNo
TakequeryintNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
EventCalendarResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CalendarEventDto>No
JsonEventsformCalendarEventJsonDto[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
CalendarEventDto Parameters:
NameParameterData TypeRequiredDescription
EventPermalinkformstringNo
EventNameformstringNo
EventImageUrlformstringNo
EventTypeformstringNo
EventUrlformstringNo
EventBodyformstringNo
EventShortDescriptionformstringNo
EventLocationformstringNo
EventAddress1formstringNo
EventAddress2formstringNo
EventCityformstringNo
EventStateformstringNo
EventZipCodeformstringNo
EventHoursformstringNo
RssImageUrlformstringNo
AdmissionFeeformstringNo
ContactNameformstringNo
ContactPhoneformstringNo
ContactEmailformstringNo
ClassNamesformstringNo
EventStartformDateTimeNo
EventStartIsoformstringNo
EventStartDisplayformstringNo
EventEndformDateTimeNo
EventEndIsoformstringNo
EventEndDisplayformstringNo
IsCancelledformboolNo
CalendarEventDefinitionIdformlongNo
EventContactformDealerDirectoryDtoNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
DealerDirectoryDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateAbbrformstringNo
ZipCodeformstringNo
ProvinceRegionformstringNo
CountryformstringNo
EmailAddressformstringNo
PhoneNumberformstringNo
ActiveSubscriptionsformstringNo
AvatarUrlformstringNo
AuthorImageUrlformstringNo
AuthorBioformstringNo
ActiveSubscriberformboolNo
HasAvatarformboolNo
IsActiveCdnxformboolNo
IsFeaturedDealerformboolNo
ShowAvatarImageformboolNo
ShowAuthorImageformboolNo
ShowAuthorAsCompanyformboolNo
WebsiteUrlformstringNo
CategoriesformList<XCategoryDto>No
PermalinkformstringNo
CompanyDescriptionformstringNo
IndustryAffiliationsformstringNo
FacebookformstringNo
TwitterformstringNo
EbayIdformstringNo
InstagramformstringNo
SortNameformstringNo
XCategoryDto Parameters:
NameParameterData TypeRequiredDescription
CategoryNameformstringNo
CategoryPermaLinkformstringNo
IconformstringNo
IsValidDealerDirectoryformboolNo
IsValidEventsformboolNo
IsValidBlogformboolNo
SortOrderformintNo
CalendarEventJsonDto Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
titleformstringNo
descriptionformstringNo
urlformstringNo
classNamesformstring[]No
startformstringNo
endformstringNo
EventCalendarResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<CalendarEventDto>No
JsonEventsformCalendarEventJsonDto[]No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /EventCalendar HTTP/1.1 
Host: mobileapidevsw.greysheet.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			EventPermalink: String,
			EventName: String,
			EventImageUrl: String,
			EventType: String,
			EventUrl: String,
			EventBody: String,
			EventShortDescription: String,
			EventLocation: String,
			EventAddress1: String,
			EventAddress2: String,
			EventCity: String,
			EventState: String,
			EventZipCode: String,
			EventHours: String,
			RssImageUrl: String,
			AdmissionFee: String,
			ContactName: String,
			ContactPhone: String,
			ContactEmail: String,
			ClassNames: String,
			EventStart: 0001-01-01,
			EventStartIso: String,
			EventStartDisplay: String,
			EventEnd: 0001-01-01,
			EventEndIso: String,
			EventEndDisplay: String,
			IsCancelled: False,
			CalendarEventDefinitionId: 0,
			EventContact: 
			{
				Id: 0,
				FirstName: String,
				LastName: String,
				Company: String,
				Address1: String,
				Address2: String,
				City: String,
				StateAbbr: String,
				ZipCode: String,
				ProvinceRegion: String,
				Country: String,
				EmailAddress: String,
				PhoneNumber: String,
				ActiveSubscriptions: String,
				AvatarUrl: String,
				AuthorImageUrl: String,
				AuthorBio: String,
				ActiveSubscriber: False,
				HasAvatar: False,
				IsActiveCdnx: False,
				IsFeaturedDealer: False,
				ShowAvatarImage: False,
				ShowAuthorImage: False,
				ShowAuthorAsCompany: False,
				WebsiteUrl: String,
				Categories: 
				[
					{
						CategoryName: String,
						CategoryPermaLink: String,
						Icon: String,
						IsValidDealerDirectory: False,
						IsValidEvents: False,
						IsValidBlog: False,
						SortOrder: 0,
						Id: 0,
						Active: False,
						LastMod: 0001-01-01,
						LastModBy: String
					}
				],
				Permalink: String,
				CompanyDescription: String,
				IndustryAffiliations: String,
				Facebook: String,
				Twitter: String,
				EbayId: String,
				Instagram: String,
				SortName: String
			},
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	JsonEvents: 
	[
		{
			id: String,
			title: String,
			description: String,
			url: String,
			classNames: 
			[
				String
			],
			start: String,
			end: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}