TicketUserServices

<back to all web services

SurveyCampaignGetRequest

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

namespace TicketUserServices.ServiceModel
{
    public partial class SurveyCampaignGetRequest
    {
        public virtual int Id { get; set; }
    }

    public partial class SurveyCampaignResult
    {
        public virtual SurveyCampaign Item { get; set; }
        public virtual SurveyCampaignStats Stats { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class SurveyCampaignStats
    {
        public virtual int Recipients { get; set; }
        public virtual int Pending { get; set; }
        public virtual int Queued { get; set; }
        public virtual int Sent { get; set; }
        public virtual int Bounced { get; set; }
        public virtual int Rejected { get; set; }
        public virtual int Opened { get; set; }
        public virtual int Clicked { get; set; }
        public virtual int Responded { get; set; }
        public virtual int RemindersSent { get; set; }
        public virtual int DueForReminder { get; set; }
    }

}

namespace TicketUserServices.ServiceModel.Types
{
    public partial class SurveyCampaign
    {
        public virtual int ID { get; set; }
        [StringLength(200)]
        public virtual string Name { get; set; }

        [StringLength(16)]
        public virtual string Status { get; set; }

        [StringLength(300)]
        public virtual string Subject { get; set; }

        [StringLength(int.MaxValue)]
        public virtual string BodyHtml { get; set; }

        [StringLength(300)]
        public virtual string ReminderSubject { get; set; }

        [StringLength(int.MaxValue)]
        public virtual string ReminderBodyHtml { get; set; }

        [StringLength(320)]
        public virtual string FromEmail { get; set; }

        [StringLength(200)]
        public virtual string FromName { get; set; }

        [StringLength(8)]
        public virtual string Language { get; set; }

        public virtual int ReminderAfterDays { get; set; }
        public virtual int MaxReminders { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual DateTime? SentAt { get; set; }
        public virtual DateTime? ClosedAt { get; set; }
    }

}

C# SurveyCampaignGetRequest DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SurveyCampaignResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:BodyHtml>String</d2p1:BodyHtml>
    <d2p1:ClosedAt>0001-01-01T00:00:00</d2p1:ClosedAt>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:FromEmail>String</d2p1:FromEmail>
    <d2p1:FromName>String</d2p1:FromName>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:Language>String</d2p1:Language>
    <d2p1:MaxReminders>0</d2p1:MaxReminders>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ReminderAfterDays>0</d2p1:ReminderAfterDays>
    <d2p1:ReminderBodyHtml>String</d2p1:ReminderBodyHtml>
    <d2p1:ReminderSubject>String</d2p1:ReminderSubject>
    <d2p1:SentAt>0001-01-01T00:00:00</d2p1:SentAt>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Subject>String</d2p1:Subject>
  </Item>
  <Message>String</Message>
  <Stats>
    <Bounced>0</Bounced>
    <Clicked>0</Clicked>
    <DueForReminder>0</DueForReminder>
    <Opened>0</Opened>
    <Pending>0</Pending>
    <Queued>0</Queued>
    <Recipients>0</Recipients>
    <Rejected>0</Rejected>
    <RemindersSent>0</RemindersSent>
    <Responded>0</Responded>
    <Sent>0</Sent>
  </Stats>
  <StatusCode>0</StatusCode>
</SurveyCampaignResult>