EMUN1 ASP.NET

<back to all web services

GetCampaign

The following routes are available for this service:
All Verbs/service/GetCampaign
GetCampaign Parameters:
NameParameterData TypeRequiredDescription
CampaignIdquerystringNo

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.

POST /service/GetCampaign HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	campaignId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	archiveUrl: String,
	longArchiveUrl: String,
	contentType: String,
	createTime: 0001-01-01,
	deliveryStatus: 
	{
		enabled: False,
		canCancel: False,
		status: String,
		emailsSent: 0,
		emailsCanceled: 0
	},
	rssOptions: 
	{
		url: String,
		frequency: String,
		schedule: 
		{
			hour: 0,
			dailySend: 
			{
				sunday: False,
				monday: False,
				tuesday: False,
				wednesday: False,
				thursday: False,
				friday: False,
				saturday: False
			},
			dayOfWeekToSend: String,
			dayOfMonthToSend: 0
		},
		constrainImage: False
	},
	socialCard: 
	{
		imageUrl: String,
		description: String,
		title: String
	},
	reportSummary: 
	{
		clickRate: 0,
		clicks: 0,
		openRate: 0,
		opens: 0,
		subscriberClicks: 0,
		uniqueOpens: 0,
		ecommerce: 
		{
			totalOrders: 0,
			totalSpent: 0,
			totalRevenue: 0
		}
	},
	emailsSent: 0,
	id: String,
	webId: 0,
	links: 
	[
		{
			href: String,
			method: GET,
			rel: String,
			schema: String,
			targetSchema: String
		}
	],
	recipients: 
	{
		listId: String,
		segmentText: String,
		segmentOptions: 
		{
			match: Any,
			savedSegmentId: 0
		}
	},
	sendTime: 0001-01-01,
	settings: 
	{
		authenticate: False,
		autoFooter: False,
		autoTweet: False,
		dragAndDrop: False,
		fbComments: False,
		folderId: String,
		fromName: String,
		inlineCss: False,
		replyTo: String,
		subjectLine: String,
		templateId: 0,
		timewarp: False,
		title: String,
		toName: String,
		useConversation: False
	},
	status: String,
	tracking: 
	{
		clicktale: String,
		ecomm360: False,
		goalTracking: False,
		googleAnalytics: String,
		htmlClicks: False,
		opens: False,
		salesForce: 
		{
			createCampaignInAccount: False,
			updateNotesForCampaign: False
		},
		highRise: 
		{
			createCampaignInAccount: False,
			updateNotesForCampaign: False
		},
		capsule: 
		{
			updateNotesForCampaign: False
		},
		textClicks: False
	},
	type: 1,
	dashboardLink: String,
	variateSettings: 
	{
		winningCombinationId: String,
		winningCampaignId: String,
		winnerCriteria: String
	}
}