| POST | /v1/forms/{FormUID}/archive |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class FormArchiveRequest
{
public virtual Guid FormUID { get; set; }
}
public partial class FormCard
{
public virtual Guid FormUID { get; set; }
public virtual string Name { get; set; }
public virtual string Slug { get; set; }
public virtual string Noun { get; set; }
public virtual string NumberPrefix { get; set; }
public virtual string Description { get; set; }
public virtual string Tone { get; set; }
public virtual string Status { get; set; }
public virtual int? PublishedVersionNo { get; set; }
public virtual DateTime? PublishedAt { get; set; }
public virtual string PublishedBy { get; set; }
public virtual bool DraftDirty { get; set; }
public virtual DateTime? DraftUpdatedAt { get; set; }
public virtual string DraftUpdatedBy { get; set; }
public virtual string PackLabel { get; set; }
public virtual string SettingsJson { get; set; }
public virtual FormStats Stats { get; set; }
public virtual List<string> Offered { get; set; } = [];
public virtual string CreatedBy { get; set; }
public virtual DateTime? CreatedAt { get; set; }
public virtual DateTime? UpdatedAt { get; set; }
}
public partial class FormDetail
: FormCard
{
public virtual string DraftJson { get; set; }
public virtual int DraftRev { get; set; }
public virtual Guid? SourceTemplateUID { get; set; }
public virtual List<string> Warnings { get; set; } = [];
public virtual List<string> AlwaysHidden { get; set; } = [];
}
public partial class FormResponse
{
public virtual FormDetail Form { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class FormStats
{
public virtual int Total { get; set; }
public virtual int NeedDecision { get; set; }
public virtual int Waiting { get; set; }
public virtual int Overdue { get; set; }
}
}
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.
POST /v1/forms/{FormUID}/archive HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FormUID: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Form:
{
DraftJson: String,
DraftRev: 0,
SourceTemplateUID: 00000000000000000000000000000000,
Warnings:
[
String
],
AlwaysHidden:
[
String
],
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
}
}
}