TicketUserServices

<back to all web services

SurveyRecipientImportRequest

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

public class SurveyRecipientImportRequest : Codable
{
    public var campaignId:Int?
    public var rows:[SurveyRecipientImportRow] = []

    required public init(){}
}

public class SurveyRecipientImportRow : Codable
{
    public var email:String?
    public var segment:String?
    public var surveyUrl:String?

    required public init(){}
}

public class SurveyRecipientImportResult : Codable
{
    public var inserted:Int?
    public var skipped:Int?
    public var invalid:Int?
    public var invalidRows:[String] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}


Swift SurveyRecipientImportRequest 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}/Recipients HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

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