TicketUserServices

<back to all web services

SurveyCampaignGetRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/SurveyCampaign/{Id}
SurveyCampaignGetRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
SurveyCampaignResult Parameters:
NameParameterData TypeRequiredDescription
ItemformSurveyCampaignNo
StatsformSurveyCampaignStatsNo
StatusCodeformintNo
MessageformstringNo
SurveyCampaign Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
StatusformstringNo
SubjectformstringNo
BodyHtmlformstringNo
ReminderSubjectformstringNo
ReminderBodyHtmlformstringNo
FromEmailformstringNo
FromNameformstringNo
LanguageformstringNo
ReminderAfterDaysformintNo
MaxRemindersformintNo
CreatedAtformDateTimeNo
SentAtformDateTime?No
ClosedAtformDateTime?No
SurveyCampaignStats Parameters:
NameParameterData TypeRequiredDescription
RecipientsformintNo
PendingformintNo
QueuedformintNo
SentformintNo
BouncedformintNo
RejectedformintNo
OpenedformintNo
ClickedformintNo
RespondedformintNo
RemindersSentformintNo
DueForReminderformintNo

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 /SurveyCampaign/{Id} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		id: 0,
		name: String,
		status: String,
		subject: String,
		bodyHtml: String,
		reminderSubject: String,
		reminderBodyHtml: String,
		fromEmail: String,
		fromName: String,
		language: String,
		reminderAfterDays: 0,
		maxReminders: 0,
		createdAt: 0001-01-01,
		sentAt: 0001-01-01,
		closedAt: 0001-01-01
	},
	stats: 
	{
		recipients: 0,
		pending: 0,
		queued: 0,
		sent: 0,
		bounced: 0,
		rejected: 0,
		opened: 0,
		clicked: 0,
		responded: 0,
		remindersSent: 0,
		dueForReminder: 0
	},
	statusCode: 0,
	message: String
}