TicketUserServices

<back to all web services

SurveyCampaignSendRequest

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

export class SurveyCampaignSendResult
{
    public queued?: number;
    public skipped?: number;
    public remaining?: number;
    public statusCode?: number;
    public message?: string;

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

export class SurveyCampaignSendRequest
{
    public campaignId?: number;
    public limit?: number;
    public testMode?: boolean;
    public testEmails?: string[];
    public useEngine?: boolean;

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

TypeScript SurveyCampaignSendRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SurveyCampaign/{CampaignId}/Send HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"campaignId":0,"limit":0,"testMode":false,"testEmails":["String"],"useEngine":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"queued":0,"skipped":0,"remaining":0,"statusCode":0,"message":"String"}