POST api/promotionalevents/search
Performs a search of promotional events based on the given .
Request Information
URI Parameters
None.
Body Parameters
PromotionalEventCriteriaDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| FromDate | date |
None. |
|
| ToDate | date |
None. |
|
| PrincipalUserId | globally unique identifier |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| AddressId | globally unique identifier |
None. |
|
| CampaignId | globally unique identifier |
None. |
|
| SecurityGroupIds | Collection of globally unique identifier |
None. |
|
| IsDeleted | boolean |
None. |
|
| ProductId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "c5e61e27-9265-4cf2-a7a1-fa65339b093e",
"Name": "sample string 1",
"FromDate": "2025-12-11T00:42:39.9452158+00:00",
"ToDate": "2025-12-11T00:42:39.9452158+00:00",
"PrincipalUserId": "16439880-b91b-4863-af74-c02918ce623f",
"CompanyId": "e2665744-0070-43bd-87b6-235c68601279",
"AddressId": "c75a6b83-6f51-4ce1-a38a-1fdb3e430ce0",
"CampaignId": "3bc03e63-7a5e-4c38-a765-6ffd6cb7be21",
"SecurityGroupIds": [
"c970a370-769f-46e8-8d3a-91d0dcf9626e",
"1beb9e07-20b1-41f2-b4fc-5bd44d1c1f3f"
],
"IsDeleted": true,
"ProductId": "1cd66217-6e38-467d-bb83-ae9f453dc679"
}
application/xml, text/xml
Sample:
<PromotionalEventCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.EventManagement.Models">
<AddressId>c75a6b83-6f51-4ce1-a38a-1fdb3e430ce0</AddressId>
<CampaignId>3bc03e63-7a5e-4c38-a765-6ffd6cb7be21</CampaignId>
<CompanyId>e2665744-0070-43bd-87b6-235c68601279</CompanyId>
<FromDate>2025-12-11T00:42:39.9452158+00:00</FromDate>
<Id>c5e61e27-9265-4cf2-a7a1-fa65339b093e</Id>
<IsDeleted>true</IsDeleted>
<Name>sample string 1</Name>
<PrincipalUserId>16439880-b91b-4863-af74-c02918ce623f</PrincipalUserId>
<ProductId>1cd66217-6e38-467d-bb83-ae9f453dc679</ProductId>
<SecurityGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>c970a370-769f-46e8-8d3a-91d0dcf9626e</d2p1:guid>
<d2p1:guid>1beb9e07-20b1-41f2-b4fc-5bd44d1c1f3f</d2p1:guid>
</SecurityGroupIds>
<ToDate>2025-12-11T00:42:39.9452158+00:00</ToDate>
</PromotionalEventCriteriaDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.