Trendsic Platform Service

<back to all web services

FFFieldRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/FFField/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/FFField
import Foundation
import ServiceStack

public class FFFieldRequest : Codable
{
    public var ffField:[FFFieldExtended] = []

    required public init(){}
}

public class FFFieldExtended : FFField
{
    public var name:String
    public var isYesNo:Bool

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

    private enum CodingKeys : String, CodingKey {
        case name
        case isYesNo
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        isYesNo = try container.decodeIfPresent(Bool.self, forKey: .isYesNo)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
        if isYesNo != nil { try container.encode(isYesNo, forKey: .isYesNo) }
    }
}

public class FFField : Codable
{
    public var id:String
    public var ffSectionId:String
    public var fieldTypeId:Int
    public var x:Int
    public var y:Int
    public var height:Int
    public var width:Int
    public var text:String

    required public init(){}
}

public class FFFieldResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var ffField:[FFFieldExtended] = []

    required public init(){}
}


Swift FFFieldRequest 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/FFField/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FFField: 
	[
		{
			Name: String,
			IsYesNo: False,
			Id: 00000000000000000000000000000000,
			FFSectionId: 00000000000000000000000000000000,
			FieldTypeId: 0,
			x: 0,
			y: 0,
			height: 0,
			width: 0,
			Text: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	FFField: 
	[
		{
			Name: String,
			IsYesNo: False,
			Id: 00000000000000000000000000000000,
			FFSectionId: 00000000000000000000000000000000,
			FieldTypeId: 0,
			x: 0,
			y: 0,
			height: 0,
			width: 0,
			Text: String
		}
	]
}