| GET | /v1/forms |
|---|
import Foundation
import ServiceStack
public class FormListRequest : Codable
{
required public init(){}
}
public class FormListResponse : Codable
{
public var forms:[FormCard] = []
public var responseStatus:ResponseStatus
required public init(){}
}
public class FormCard : Codable
{
public var formUID:String
public var name:String
public var slug:String
public var noun:String
public var numberPrefix:String
public var Description:String
public var tone:String
public var status:String
public var publishedVersionNo:Int?
public var publishedAt:Date?
public var publishedBy:String
public var draftDirty:Bool
public var draftUpdatedAt:Date?
public var draftUpdatedBy:String
public var packLabel:String
public var settingsJson:String
public var stats:FormStats
public var offered:[String] = []
public var createdBy:String
public var createdAt:Date?
public var updatedAt:Date?
required public init(){}
}
public class FormStats : Codable
{
public var total:Int
public var needDecision:Int
public var waiting:Int
public var overdue:Int
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/forms HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Forms:
[
{
FormUID: 00000000000000000000000000000000,
Name: String,
Slug: String,
Noun: String,
NumberPrefix: String,
Description: String,
Tone: String,
Status: String,
PublishedVersionNo: 0,
PublishedAt: 0001-01-01,
PublishedBy: String,
DraftDirty: False,
DraftUpdatedAt: 0001-01-01,
DraftUpdatedBy: String,
PackLabel: String,
SettingsJson: String,
Stats:
{
Total: 0,
NeedDecision: 0,
Waiting: 0,
Overdue: 0
},
Offered:
[
String
],
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}