YM REST Services

AllCampaigns

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/AllCampaigns	Return a list of all Campaigns and their data.

**AllCampaigns** Parameters:
Name	Parameter	Data Type	Required
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

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**AllCampaignsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
TotalCount	form	int	No
Campaigns	form	List<AllCampaignData>	No

**AllCampaignData** Parameters:
Name	Parameter	Data Type	Required
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TotalCount: 0,
	Campaigns: 
	[
		{
			Id: 0,
			CampaignName: String,
			DateCreated: 0001-01-01,
			DateScheduled: 0001-01-01,
			DateStartProcessing: 0001-01-01,
			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-03T05:46:12.1249200-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-03T08:42:07.5895633-04:00,
	Device: Desktop
}