TicketUserServices

<back to all web services

SurveyCampaignGetRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/SurveyCampaign/{Id}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel
Imports TicketUserServices.ServiceModel.Types

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class SurveyCampaignGetRequest
            Public Overridable Property Id As Integer
        End Class

        Public Partial Class SurveyCampaignResult
            Public Overridable Property Item As SurveyCampaign
            Public Overridable Property Stats As SurveyCampaignStats
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class SurveyCampaignStats
            Public Overridable Property Recipients As Integer
            Public Overridable Property Pending As Integer
            Public Overridable Property Queued As Integer
            Public Overridable Property Sent As Integer
            Public Overridable Property Bounced As Integer
            Public Overridable Property Rejected As Integer
            Public Overridable Property Opened As Integer
            Public Overridable Property Clicked As Integer
            Public Overridable Property Responded As Integer
            Public Overridable Property RemindersSent As Integer
            Public Overridable Property DueForReminder As Integer
        End Class
    End Namespace

    Namespace TicketUserServices.ServiceModel.Types

        Public Partial Class SurveyCampaign
            Public Overridable Property ID As Integer
            <StringLength(200)>
            Public Overridable Property Name As String

            <StringLength(16)>
            Public Overridable Property Status As String

            <StringLength(300)>
            Public Overridable Property Subject As String

            <StringLength(Integer.MaxValue)>
            Public Overridable Property BodyHtml As String

            <StringLength(300)>
            Public Overridable Property ReminderSubject As String

            <StringLength(Integer.MaxValue)>
            Public Overridable Property ReminderBodyHtml As String

            <StringLength(320)>
            Public Overridable Property FromEmail As String

            <StringLength(200)>
            Public Overridable Property FromName As String

            <StringLength(8)>
            Public Overridable Property Language As String

            Public Overridable Property ReminderAfterDays As Integer
            Public Overridable Property MaxReminders As Integer
            Public Overridable Property CreatedAt As Date
            Public Overridable Property SentAt As Nullable(Of Date)
            Public Overridable Property ClosedAt As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET SurveyCampaignGetRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /SurveyCampaign/{Id} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"item":{"id":0,"name":"String","status":"String","subject":"String","bodyHtml":"String","reminderSubject":"String","reminderBodyHtml":"String","fromEmail":"String","fromName":"String","language":"String","reminderAfterDays":0,"maxReminders":0,"createdAt":"0001-01-01T00:00:00.0000000","sentAt":"0001-01-01T00:00:00.0000000","closedAt":"0001-01-01T00:00:00.0000000"},"stats":{"recipients":0,"pending":0,"queued":0,"sent":0,"bounced":0,"rejected":0,"opened":0,"clicked":0,"responded":0,"remindersSent":0,"dueForReminder":0},"statusCode":0,"message":"String"}