TicketUserServices

<back to all web services

SurveyRecipientImportRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Recipients
SurveyRecipientImportRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignIdpathintNo
RowsbodyList<SurveyRecipientImportRow>No
SurveyRecipientImportRow Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
SegmentformstringNo
SurveyUrlformstringNo
SurveyRecipientImportResult Parameters:
NameParameterData TypeRequiredDescription
InsertedformintNo
SkippedformintNo
InvalidformintNo
InvalidRowsformList<string>No
StatusCodeformintNo
MessageformstringNo

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

{
	campaignId: 0,
	rows: 
	[
		{
			email: String,
			segment: String,
			surveyUrl: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	inserted: 0,
	skipped: 0,
	invalid: 0,
	invalidRows: 
	[
		String
	],
	statusCode: 0,
	message: String
}