| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Forms>
<FormCard>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<Description>String</Description>
<DraftDirty>false</DraftDirty>
<DraftUpdatedAt>0001-01-01T00:00:00</DraftUpdatedAt>
<DraftUpdatedBy>String</DraftUpdatedBy>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Name>String</Name>
<Noun>String</Noun>
<NumberPrefix>String</NumberPrefix>
<Offered xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Offered>
<PackLabel>String</PackLabel>
<PublishedAt>0001-01-01T00:00:00</PublishedAt>
<PublishedBy>String</PublishedBy>
<PublishedVersionNo>0</PublishedVersionNo>
<SettingsJson>String</SettingsJson>
<Slug>String</Slug>
<Stats>
<NeedDecision>0</NeedDecision>
<Overdue>0</Overdue>
<Total>0</Total>
<Waiting>0</Waiting>
</Stats>
<Status>String</Status>
<Tone>String</Tone>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
</FormCard>
</Forms>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</FormListResponse>