| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/AllCampaigns | Return a list of all Campaigns and their data. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | query | int | No | |
| PageSize | query | int | No | |
| PageNumber | query | int | No | |
| CampaignStatus | query | BulkEmailStatus | No | |
| IsNewsLetters | query | bool | No | |
| OrderBy | query | string | No | |
| OrderByDirection | query | string | No | |
| Type | query | CampaignType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalCount | form | int | No | |
| Campaigns | form | List<AllCampaignData> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CampaignName | form | string | No | |
| DateCreated | form | DateTime | No | |
| DateScheduled | form | DateTime? | No | |
| DateStartProcessing | form | DateTime? | No | |
| CampaignStatus | form | BulkEmailStatus | No | |
| CategoryId | form | int | No | |
| MarkupId | form | int | No | |
| Processed | form | int | No | |
| Version | form | int | No | |
| HasCampaignExpired | form | bool | No | |
| Type | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/AllCampaigns HTTP/1.1
Host: ws.yourmembership.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"TotalCount":0,"Campaigns":[{"Id":0,"CampaignName":"String","DateCreated":"0001-01-01T00:00:00.0000000","DateScheduled":"0001-01-01T00:00:00.0000000","DateStartProcessing":"0001-01-01T00:00:00.0000000","CampaignStatus":"InQueue","CategoryId":0,"MarkupId":0,"Processed":0,"Version":0,"HasCampaignExpired":false,"Type":"String"}],"CampaignId":0,"PageSize":0,"PageNumber":0,"CampaignStatus":"InQueue","IsNewsLetters":false,"OrderBy":"String","OrderByDirection":"String","Type":"Email","UsingRedis":true,"AppInitTime":"2024-05-02T22:46:00.1553775-04:00","ServerID":"WS-4-7-585","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T00:16:29.2866810-04:00","Device":"Desktop"}