TicketUserServices

<back to all web services

SurveyRecipientImportRequest

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

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SurveyRecipientImportResult() = 
        member val Inserted:Int32 = new Int32() with get,set
        member val Skipped:Int32 = new Int32() with get,set
        member val Invalid:Int32 = new Int32() with get,set
        member val InvalidRows:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type SurveyRecipientImportRow() = 
        member val Email:String = null with get,set
        member val Segment:String = null with get,set
        member val SurveyUrl:String = null with get,set

    [<AllowNullLiteral>]
    type SurveyRecipientImportRequest() = 
        member val CampaignId:Int32 = new Int32() with get,set
        member val Rows:ResizeArray<SurveyRecipientImportRow> = new ResizeArray<SurveyRecipientImportRow>() with get,set

F# 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"}