| POST | /v1/forms/{FormUID}/archive |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class FormArchiveRequest
{
open var FormUID:UUID? = null
}
open class FormResponse
{
open var Form:FormDetail? = null
open var ResponseStatus:ResponseStatus? = null
}
open class FormDetail : FormCard()
{
open var DraftJson:String? = null
open var DraftRev:Int? = null
open var SourceTemplateUID:UUID? = null
open var Warnings:ArrayList<String> = ArrayList<String>()
open var AlwaysHidden:ArrayList<String> = ArrayList<String>()
}
open class FormCard
{
open var FormUID:UUID? = null
open var Name:String? = null
open var Slug:String? = null
open var Noun:String? = null
open var NumberPrefix:String? = null
open var Description:String? = null
open var Tone:String? = null
open var Status:String? = null
open var PublishedVersionNo:Int? = null
open var PublishedAt:Date? = null
open var PublishedBy:String? = null
open var DraftDirty:Boolean? = null
open var DraftUpdatedAt:Date? = null
open var DraftUpdatedBy:String? = null
open var PackLabel:String? = null
open var SettingsJson:String? = null
open var Stats:FormStats? = null
open var Offered:ArrayList<String> = ArrayList<String>()
open var CreatedBy:String? = null
open var CreatedAt:Date? = null
open var UpdatedAt:Date? = null
}
open class FormStats
{
open var Total:Int? = null
open var NeedDecision:Int? = null
open var Waiting:Int? = null
open var Overdue:Int? = null
}
Kotlin FormArchiveRequest DTOs
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.
POST /v1/forms/{FormUID}/archive HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormArchiveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
</FormArchiveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Form>
<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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1: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>
<AlwaysHidden xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</AlwaysHidden>
<DraftJson>String</DraftJson>
<DraftRev>0</DraftRev>
<SourceTemplateUID>00000000-0000-0000-0000-000000000000</SourceTemplateUID>
<Warnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Warnings>
</Form>
<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>
</FormResponse>