Trendsic Platform Service

<back to all web services

FormFillReplyRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/request/send
import Foundation
import ServiceStack

public class FormFillReplyRequest : Codable
{
    public var token:String
    public var requestUID:String
    public var answersJson:String
    public var lang:String

    required public init(){}
}

public class FormFillReplyResponse : Codable
{
    public var sent:Bool
    public var status:FormFillStatusResponse
    public var errors:[FormFillFieldError] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormFillStatusResponse : Codable
{
    public var number:String
    public var formName:String
    public var noun:String
    public var tenantName:String
    public var stage:String
    public var stageKind:String
    public var stages:[FormFillStage] = []
    public var seen:[FormFillStageSeen] = []
    public var submittedAt:Date?
    public var receipt:[FormFillReceiptLine] = []
    public var canWithdraw:Bool
    public var lang:String
    public var nounEs:String
    public var hasRequest:Bool
    public var requestNote:String
    public var outcome:String
    public var decisionReason:String
    public var decisionNote:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormFillStage : Codable
{
    public var id:String
    public var label:String
    public var tone:String
    public var kind:String

    required public init(){}
}

public class FormFillStageSeen : Codable
{
    public var id:String
    public var at:Date

    required public init(){}
}

public class FormFillReceiptLine : Codable
{
    public var channel:String
    public var to:String
    public var outcome:String

    required public init(){}
}

public class FormFillFieldError : Codable
{
    public var k:String
    public var msg:String

    required public init(){}
}


Swift FormFillReplyRequest 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.

POST /v1/formfill/status/{Token}/request/send HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	RequestUID: String,
	AnswersJson: String,
	Lang: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Sent: False,
	Status: 
	{
		Number: String,
		FormName: String,
		Noun: String,
		TenantName: String,
		Stage: String,
		StageKind: String,
		Stages: 
		[
			{
				Id: String,
				Label: String,
				Tone: String,
				Kind: String
			}
		],
		Seen: 
		[
			{
				Id: String,
				At: 0001-01-01
			}
		],
		SubmittedAt: 0001-01-01,
		Receipt: 
		[
			{
				Channel: String,
				To: String,
				Outcome: String
			}
		],
		CanWithdraw: False,
		Lang: String,
		NounEs: String,
		HasRequest: False,
		RequestNote: String,
		Outcome: String,
		DecisionReason: String,
		DecisionNote: String,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	},
	Errors: 
	[
		{
			K: String,
			Msg: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}