Trendsic Platform Service

<back to all web services

GiftCardSurveyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/Survey/GiftCard/{UID}
import Foundation
import ServiceStack

public class GiftCardSurveyRequest : Codable
{
    public var uid:String

    required public init(){}
}

public class GiftCardSurveyResponse : Codable
{
    public var survey:GiftCardSurvey
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class GiftCardSurvey : Survey
{
    public var giftCardId:Int
    public var giftCards:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case giftCardId
        case giftCards
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        giftCardId = try container.decodeIfPresent(Int.self, forKey: .giftCardId)
        giftCards = try container.decodeIfPresent([String].self, forKey: .giftCards) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if giftCardId != nil { try container.encode(giftCardId, forKey: .giftCardId) }
        if giftCards.count > 0 { try container.encode(giftCards, forKey: .giftCards) }
    }
}

public class Survey : Codable
{
    public var surveyId:Int
    public var contactId:Int
    public var questions:[SurveyQuestion] = []

    required public init(){}
}

public class SurveyQuestion : Codable
{
    public var questionId:Int
    public var questionType:String
    public var html:String
    public var dependsOn:String

    required public init(){}
}


Swift GiftCardSurveyRequest 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 /v1/Survey/GiftCard/{UID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardSurveyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Survey>
    <ContactId>0</ContactId>
    <Questions>
      <SurveyQuestion>
        <DependsOn>String</DependsOn>
        <HTML>String</HTML>
        <QuestionId>0</QuestionId>
        <QuestionType>String</QuestionType>
      </SurveyQuestion>
    </Questions>
    <SurveyId>0</SurveyId>
    <GiftCardId>0</GiftCardId>
    <GiftCards xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </GiftCards>
  </Survey>
</GiftCardSurveyResponse>