Trendsic Platform Service

<back to all web services

FormFillReplyRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/request/send
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormFillStage() = 
        member val Id:String = null with get,set
        member val Label:String = null with get,set
        member val Tone:String = null with get,set
        member val Kind:String = null with get,set

    [<AllowNullLiteral>]
    type FormFillStageSeen() = 
        member val Id:String = null with get,set
        member val At:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type FormFillReceiptLine() = 
        member val Channel:String = null with get,set
        member val To:String = null with get,set
        member val Outcome:String = null with get,set

    [<AllowNullLiteral>]
    type FormFillStatusResponse() = 
        member val Number:String = null with get,set
        member val FormName:String = null with get,set
        member val Noun:String = null with get,set
        member val TenantName:String = null with get,set
        member val Stage:String = null with get,set
        member val StageKind:String = null with get,set
        member val Stages:ResizeArray<FormFillStage> = new ResizeArray<FormFillStage>() with get,set
        member val Seen:ResizeArray<FormFillStageSeen> = new ResizeArray<FormFillStageSeen>() with get,set
        member val SubmittedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Receipt:ResizeArray<FormFillReceiptLine> = new ResizeArray<FormFillReceiptLine>() with get,set
        member val CanWithdraw:Boolean = new Boolean() with get,set
        member val Lang:String = null with get,set
        member val NounEs:String = null with get,set
        member val HasRequest:Boolean = new Boolean() with get,set
        member val RequestNote:String = null with get,set
        member val Outcome:String = null with get,set
        member val DecisionReason:String = null with get,set
        member val DecisionNote:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormFillFieldError() = 
        member val K:String = null with get,set
        member val Msg:String = null with get,set

    [<AllowNullLiteral>]
    type FormFillReplyResponse() = 
        member val Sent:Boolean = new Boolean() with get,set
        member val Status:FormFillStatusResponse = null with get,set
        member val Errors:ResizeArray<FormFillFieldError> = new ResizeArray<FormFillFieldError>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormFillReplyRequest() = 
        member val Token:String = null with get,set
        member val RequestUID:String = null with get,set
        member val AnswersJson:String = null with get,set
        member val Lang:String = null with get,set

F# 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
		}
	}
}