POST banners
Request Information
URI Parameters
None.
Body Parameters
BannerSearchDto| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeInactive | boolean |
None. |
|
| AdKeyword | string |
None. |
|
| BannerName | string |
None. |
|
| CategoryID | integer |
None. |
|
| StandardCategoryID | integer |
None. |
|
| URL | string |
None. |
|
| ProfileName | string |
None. |
|
| SearchStartDate | date |
None. |
|
| SearchEndDate | date |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| OrderBy | string |
None. |
|
| OrderByPropertyNameMapping | Dictionary of string [key] and string [value] |
None. |
|
| OrderByPropertyMappingPrefixesToIgnore | Collection of string |
None. |
|
| OrderByPropertyMappingPrefixesToAppend | Collection of string |
None. |
|
| OrderByExpression | string |
None. |
|
| ObjectState | ObjectStateEnum |
None. |
Request Formats
application/json, text/json
Sample:
{
- "IncludeInactive": true,
- "AdKeyword": "sample string 2",
- "BannerName": "sample string 3",
- "CategoryID": 1,
- "StandardCategoryID": 1,
- "URL": "sample string 4",
- "ProfileName": "sample string 5",
- "SearchStartDate": "2025-10-24T01:25:41.540773Z",
- "SearchEndDate": "2025-10-24T01:25:41.540773Z",
- "PageNumber": 6,
- "PageSize": 7,
- "OrderBy": "sample string 8",
- "OrderByPropertyNameMapping": {
- "sample string 1": "sample string 2",
- "sample string 3": "sample string 4"
- "OrderByPropertyMappingPrefixesToIgnore": [
- "sample string 1",
- "sample string 2"
- "OrderByPropertyMappingPrefixesToAppend": [
- "sample string 1",
- "sample string 2"
- "OrderByExpression": "sample string 2sample string 1sample string 8 Asc",
- "ObjectState": 0
Response Information
Resource Description
Collection of BannerDto| Name | Description | Type | Additional information |
|---|---|---|---|
| BannerId | integer |
None. |
|
| ProfileId | integer |
None. |
|
| ImageUrl | string |
None. |
|
| NavigateUrl | string |
None. |
|
| AlternateText | string |
None. |
|
| Keyword | string |
None. |
|
| DisplayStartDate | date |
None. |
|
| DisplayEndDate | date |
None. |
|
| DateCreated | date |
None. |
|
| DateChanged | date |
None. |
|
| ChangedBy | string |
None. |
|
| Target | string |
None. |
|
| BannerName | string |
None. |
|
| BannerTypeId | integer |
None. |
|
| BannerFormat | integer |
None. |
|
| ProfileReportName | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
- {
- "BannerId": 1,
- "ProfileId": 2,
- "ImageUrl": "sample string 3",
- "NavigateUrl": "sample string 4",
- "AlternateText": "sample string 5",
- "Keyword": "sample string 6",
- "DisplayStartDate": "2025-10-24T01:25:41.5595892Z",
- "DisplayEndDate": "2025-10-24T01:25:41.5595892Z",
- "DateCreated": "2025-10-24T01:25:41.5595892Z",
- "DateChanged": "2025-10-24T01:25:41.5595892Z",
- "ChangedBy": "sample string 11",
- "Target": "sample string 12",
- "BannerName": "sample string 13",
- "BannerTypeId": 14,
- "BannerFormat": 15,
- "ProfileReportName": "sample string 16"
{
- "BannerId": 1,
- "ProfileId": 2,
- "ImageUrl": "sample string 3",
- "NavigateUrl": "sample string 4",
- "AlternateText": "sample string 5",
- "Keyword": "sample string 6",
- "DisplayStartDate": "2025-10-24T01:25:41.5595892Z",
- "DisplayEndDate": "2025-10-24T01:25:41.5595892Z",
- "DateCreated": "2025-10-24T01:25:41.5595892Z",
- "DateChanged": "2025-10-24T01:25:41.5595892Z",
- "ChangedBy": "sample string 11",
- "Target": "sample string 12",
- "BannerName": "sample string 13",
- "BannerTypeId": 14,
- "BannerFormat": 15,
- "ProfileReportName": "sample string 16"