This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
Community Events and Promotions.
Parameters:
- CommId
- BuilderId
- Unpublished
- Partner Id
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| commId |
Required Community Id |
integer |
Required |
| builderId |
Optional Builder Id |
integer |
None. |
| unpublished |
Whether it will retrieve unPublished Data |
boolean |
Default value is False |
| partnerId |
Partner Id |
integer |
Default value is 1 |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": {
"Promos": [
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:28:57.2199564-05:00",
"End": "2025-04-19T09:28:57.2199564-05:00",
"Id": 8,
"TxtLng": "sample string 9",
"TxtShrt": "sample string 10"
},
{
"Title": "sample string 1",
"Desc": "sample string 2",
"Type": "sample string 3",
"Url": "sample string 4",
"Flyer": "sample string 5",
"Start": "2025-04-19T09:28:57.2199564-05:00",
"End": "2025-04-19T09:28:57.2199564-05:00",
"Id": 8,
"TxtLng": "sample string 9",
"TxtShrt": "sample string 10"
}
],
"Events": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"EventFlyerUrl": "sample string 5",
"EventStartTime": "2025-04-19T09:28:57.2199564-05:00",
"EventEndTime": "2025-04-19T09:28:57.2199564-05:00",
"EventTypeCode": "sample string 8",
"FlyerId": 1
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Location": "sample string 4",
"EventFlyerUrl": "sample string 5",
"EventStartTime": "2025-04-19T09:28:57.2199564-05:00",
"EventEndTime": "2025-04-19T09:28:57.2199564-05:00",
"EventTypeCode": "sample string 8",
"FlyerId": 1
}
]
}
}
<Root>
<Time>sample string 1</Time>
<Error>
<ClassName>System.Exception</ClassName>
<Message />
<Data />
<InnerException />
<HelpURL>sample string 1</HelpURL>
<StackTraceString />
<RemoteStackTraceString />
<RemoteStackIndex>0</RemoteStackIndex>
<ExceptionMethod />
<HResult>3</HResult>
<Source>sample string 2</Source>
<WatsonBuckets />
</Error>
<ErrorMessage>sample string 2</ErrorMessage>
<Status>sample string 3</Status>
<Server>sample string 4</Server>
<Count>1</Count>
<FavoriteCounts>
<CommCount>1</CommCount>
<PlanCount>2</PlanCount>
<SpecCount>3</SpecCount>
</FavoriteCounts>
<FavoriteFacets>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
</FavoriteFacets>
<Result>
<Promos>
<Title>sample string 1</Title>
<Desc>sample string 2</Desc>
<Type>sample string 3</Type>
<Url>sample string 4</Url>
<Flyer>sample string 5</Flyer>
<Start>2025-04-19T09:28:57.2199564-05:00</Start>
<End>2025-04-19T09:28:57.2199564-05:00</End>
<Id>8</Id>
<TxtLng>sample string 9</TxtLng>
<TxtShrt>sample string 10</TxtShrt>
</Promos>
<Promos>
<Title>sample string 1</Title>
<Desc>sample string 2</Desc>
<Type>sample string 3</Type>
<Url>sample string 4</Url>
<Flyer>sample string 5</Flyer>
<Start>2025-04-19T09:28:57.2199564-05:00</Start>
<End>2025-04-19T09:28:57.2199564-05:00</End>
<Id>8</Id>
<TxtLng>sample string 9</TxtLng>
<TxtShrt>sample string 10</TxtShrt>
</Promos>
<Events>
<Id>1</Id>
<Title>sample string 2</Title>
<Description>sample string 3</Description>
<Location>sample string 4</Location>
<EventFlyerUrl>sample string 5</EventFlyerUrl>
<EventStartTime>2025-04-19T09:28:57.2199564-05:00</EventStartTime>
<EventEndTime>2025-04-19T09:28:57.2199564-05:00</EventEndTime>
<EventTypeCode>sample string 8</EventTypeCode>
<FlyerId>1</FlyerId>
</Events>
<Events>
<Id>1</Id>
<Title>sample string 2</Title>
<Description>sample string 3</Description>
<Location>sample string 4</Location>
<EventFlyerUrl>sample string 5</EventFlyerUrl>
<EventStartTime>2025-04-19T09:28:57.2199564-05:00</EventStartTime>
<EventEndTime>2025-04-19T09:28:57.2199564-05:00</EventEndTime>
<EventTypeCode>sample string 8</EventTypeCode>
<FlyerId>1</FlyerId>
</Events>
</Result>
</Root>
Code Generator
Response Information
Returns Events and Promotions of the Community
ApiResultModelOfApiCommunityEventsAndPromotions| Name | Description | Type | Additional information |
|---|---|---|---|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | ApiCommunityEventsAndPromotions |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
GET
api/v2/Detail/EventsAndPromotions?commId={commId}&builderId={builderId}&unpublished={unpublished}&partnerId={partnerId}