TicketUserServices

<back to all web services

SurveyRecipientImportRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Recipients

export class SurveyRecipientImportResult
{
    public inserted?: number;
    public skipped?: number;
    public invalid?: number;
    public invalidRows?: string[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<SurveyRecipientImportResult>) { (Object as any).assign(this, init); }
}

export class SurveyRecipientImportRow
{
    public email?: string;
    public segment?: string;
    public surveyUrl?: string;

    public constructor(init?: Partial<SurveyRecipientImportRow>) { (Object as any).assign(this, init); }
}

export class SurveyRecipientImportRequest
{
    public campaignId?: number;
    public rows?: SurveyRecipientImportRow[];

    public constructor(init?: Partial<SurveyRecipientImportRequest>) { (Object as any).assign(this, init); }
}

TypeScript SurveyRecipientImportRequest DTOs

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
}