GET | /EventCalendar |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EventDefinitionId | query | long | No | |
EventStart | query | string | No | |
EventEnd | query | string | No | |
IsCancelled | query | bool | No | |
IsFutureOnly | query | bool | No | |
EventType | query | string | No | |
GetAll | query | bool | No | |
Skip | query | int | No | |
Take | query | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long? | No | |
OrderBy | form | string[] | No | |
OrderDirections | form | SortOrders[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<CalendarEventDto> | No | |
JsonEvents | form | CalendarEventJsonDto[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
OpCode | form | int | No | |
ErrorText | form | string | No | |
RequestTime | form | string | No | |
ResponseTime | form | string | No | |
TotalExecutionTime | form | string | No | |
CachedResponse | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EventPermalink | form | string | No | |
EventName | form | string | No | |
EventImageUrl | form | string | No | |
EventType | form | string | No | |
EventUrl | form | string | No | |
EventBody | form | string | No | |
EventShortDescription | form | string | No | |
EventLocation | form | string | No | |
EventAddress1 | form | string | No | |
EventAddress2 | form | string | No | |
EventCity | form | string | No | |
EventState | form | string | No | |
EventZipCode | form | string | No | |
EventHours | form | string | No | |
RssImageUrl | form | string | No | |
AdmissionFee | form | string | No | |
ContactName | form | string | No | |
ContactPhone | form | string | No | |
ContactEmail | form | string | No | |
ClassNames | form | string | No | |
EventStart | form | DateTime | No | |
EventStartIso | form | string | No | |
EventStartDisplay | form | string | No | |
EventEnd | form | DateTime | No | |
EventEndIso | form | string | No | |
EventEndDisplay | form | string | No | |
IsCancelled | form | bool | No | |
CalendarEventDefinitionId | form | long | No | |
EventContact | form | DealerDirectoryDto | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Active | form | bool | No | |
LastMod | form | DateTime | No | |
LastModBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Company | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
StateAbbr | form | string | No | |
ZipCode | form | string | No | |
ProvinceRegion | form | string | No | |
Country | form | string | No | |
EmailAddress | form | string | No | |
PhoneNumber | form | string | No | |
ActiveSubscriptions | form | string | No | |
AvatarUrl | form | string | No | |
AuthorImageUrl | form | string | No | |
AuthorBio | form | string | No | |
ActiveSubscriber | form | bool | No | |
HasAvatar | form | bool | No | |
IsActiveCdnx | form | bool | No | |
IsFeaturedDealer | form | bool | No | |
ShowAvatarImage | form | bool | No | |
ShowAuthorImage | form | bool | No | |
ShowAuthorAsCompany | form | bool | No | |
WebsiteUrl | form | string | No | |
Categories | form | List<XCategoryDto> | No | |
Permalink | form | string | No | |
CompanyDescription | form | string | No | |
IndustryAffiliations | form | string | No | |
form | string | No | ||
form | string | No | ||
EbayId | form | string | No | |
form | string | No | ||
SortName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryName | form | string | No | |
CategoryPermaLink | form | string | No | |
Icon | form | string | No | |
IsValidDealerDirectory | form | bool | No | |
IsValidEvents | form | bool | No | |
IsValidBlog | form | bool | No | |
SortOrder | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | string | No | |
title | form | string | No | |
description | form | string | No | |
url | form | string | No | |
classNames | form | string[] | No | |
start | form | string | No | |
end | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<CalendarEventDto> | No | |
JsonEvents | form | CalendarEventJsonDto[] | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 }