CampaignController
Base route: marketing/campaign
| Namespace | Axiom.App.Marketing.Api |
|---|---|
| Base Route | marketing/campaign |
| Security | SalesProfessional, SalesEssential |
Endpoints
| Method | Route | Method Name | Parameters | Return Type |
|---|---|---|---|---|
| Get | marketing/campaign/lists/{Id:int} |
GetList | id: int, searchText: string, skip: int, limit: int, tags: List<string>, orderBy: string, direction: string, filters: string | List |
| Get | marketing/campaign/{campaignId:int} |
Get | campaignId: int | Campaign |
| Get | marketing/campaign/publish/{campaignId:int} |
GetPublish | campaignId: int | CampaignPublishReport |
| Get | marketing/campaign/lists |
GetDocumentLists | None | List<DocumentListBasic> |
| Get | marketing/campaign/form/{form}/ |
GetForm | form: string | DocumentForm |
| Get | marketing/campaign/count |
GetTotalCount | None | int |
| Post | marketing/campaign/publish/{campaignId:int} |
Publish | campaignId: int | bool |
| Post | marketing/campaign/unpublish/{campaignId:int} |
UnPublish | campaignId: int | bool |
| Post | marketing/campaign/deleteselected |
DeleteSelected | selectedIds: List<int> | bool |
Detailed Endpoint Information
Get
marketing/campaign/lists/{Id:int}
GetList
Return Type
List
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
id |
int |
Query | No |
searchText |
string |
Query | No |
skip |
int |
Query | No |
limit |
int |
Query | No |
tags |
List<string> |
FromQuery | No |
orderBy |
string |
Query | No |
direction |
string |
Query | No |
filters |
string |
Query | No |
Get
marketing/campaign/{campaignId:int}
Get
Return Type
Campaign
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
campaignId |
int |
Query | No |
Get
marketing/campaign/publish/{campaignId:int}
GetPublish
Return Type
CampaignPublishReport
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
campaignId |
int |
Query | No |
Get
marketing/campaign/lists
GetDocumentLists
Return Type
List<DocumentListBasic>
Parameters
No parameters
Get
marketing/campaign/form/{form}/
GetForm
Return Type
DocumentForm
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
form |
string |
Query | No |
Get
marketing/campaign/count
GetTotalCount
Return Type
int
Parameters
No parameters
Post
marketing/campaign/publish/{campaignId:int}
Publish
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
campaignId |
int |
Query | No |
Post
marketing/campaign/unpublish/{campaignId:int}
UnPublish
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
campaignId |
int |
Query | No |
Post
marketing/campaign/deleteselected
DeleteSelected
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
selectedIds |
List<int> |
FromBody | No |