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 .jsv suffix or ?format=jsv

HTTP + JSV

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

{
	Survey: 
	{
		GiftCardId: 0,
		GiftCards: 
		[
			String
		],
		SurveyId: 0,
		ContactId: 0,
		Questions: 
		[
			{
				QuestionId: 0,
				QuestionType: String,
				HTML: String,
				DependsOn: String
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}