| PUT | /v1/forms/{FormUID} |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class FormStats implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Total=0,
/** @var int */
public int $NeedDecision=0,
/** @var int */
public int $Waiting=0,
/** @var int */
public int $Overdue=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['NeedDecision'])) $this->NeedDecision = $o['NeedDecision'];
if (isset($o['Waiting'])) $this->Waiting = $o['Waiting'];
if (isset($o['Overdue'])) $this->Overdue = $o['Overdue'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->NeedDecision)) $o['NeedDecision'] = $this->NeedDecision;
if (isset($this->Waiting)) $o['Waiting'] = $this->Waiting;
if (isset($this->Overdue)) $o['Overdue'] = $this->Overdue;
return empty($o) ? new class(){} : $o;
}
}
class FormCard implements JsonSerializable
{
public function __construct(
/** @var string */
public string $FormUID='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Slug=null,
/** @var string|null */
public ?string $Noun=null,
/** @var string|null */
public ?string $NumberPrefix=null,
/** @var string|null */
public ?string $Description=null,
/** @var string|null */
public ?string $Tone=null,
/** @var string|null */
public ?string $Status=null,
/** @var int|null */
public ?int $PublishedVersionNo=null,
/** @var DateTime|null */
public ?DateTime $PublishedAt=null,
/** @var string|null */
public ?string $PublishedBy=null,
/** @var bool|null */
public ?bool $DraftDirty=null,
/** @var DateTime|null */
public ?DateTime $DraftUpdatedAt=null,
/** @var string|null */
public ?string $DraftUpdatedBy=null,
/** @var string|null */
public ?string $PackLabel=null,
/** @var string|null */
public ?string $SettingsJson=null,
/** @var FormStats|null */
public ?FormStats $Stats=null,
/** @var array<string>|null */
public ?array $Offered=null,
/** @var string|null */
public ?string $CreatedBy=null,
/** @var DateTime|null */
public ?DateTime $CreatedAt=null,
/** @var DateTime|null */
public ?DateTime $UpdatedAt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FormUID'])) $this->FormUID = $o['FormUID'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Slug'])) $this->Slug = $o['Slug'];
if (isset($o['Noun'])) $this->Noun = $o['Noun'];
if (isset($o['NumberPrefix'])) $this->NumberPrefix = $o['NumberPrefix'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Tone'])) $this->Tone = $o['Tone'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['PublishedVersionNo'])) $this->PublishedVersionNo = $o['PublishedVersionNo'];
if (isset($o['PublishedAt'])) $this->PublishedAt = JsonConverters::from('DateTime', $o['PublishedAt']);
if (isset($o['PublishedBy'])) $this->PublishedBy = $o['PublishedBy'];
if (isset($o['DraftDirty'])) $this->DraftDirty = $o['DraftDirty'];
if (isset($o['DraftUpdatedAt'])) $this->DraftUpdatedAt = JsonConverters::from('DateTime', $o['DraftUpdatedAt']);
if (isset($o['DraftUpdatedBy'])) $this->DraftUpdatedBy = $o['DraftUpdatedBy'];
if (isset($o['PackLabel'])) $this->PackLabel = $o['PackLabel'];
if (isset($o['SettingsJson'])) $this->SettingsJson = $o['SettingsJson'];
if (isset($o['Stats'])) $this->Stats = JsonConverters::from('FormStats', $o['Stats']);
if (isset($o['Offered'])) $this->Offered = JsonConverters::fromArray('string', $o['Offered']);
if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FormUID)) $o['FormUID'] = $this->FormUID;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Slug)) $o['Slug'] = $this->Slug;
if (isset($this->Noun)) $o['Noun'] = $this->Noun;
if (isset($this->NumberPrefix)) $o['NumberPrefix'] = $this->NumberPrefix;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Tone)) $o['Tone'] = $this->Tone;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->PublishedVersionNo)) $o['PublishedVersionNo'] = $this->PublishedVersionNo;
if (isset($this->PublishedAt)) $o['PublishedAt'] = JsonConverters::to('DateTime', $this->PublishedAt);
if (isset($this->PublishedBy)) $o['PublishedBy'] = $this->PublishedBy;
if (isset($this->DraftDirty)) $o['DraftDirty'] = $this->DraftDirty;
if (isset($this->DraftUpdatedAt)) $o['DraftUpdatedAt'] = JsonConverters::to('DateTime', $this->DraftUpdatedAt);
if (isset($this->DraftUpdatedBy)) $o['DraftUpdatedBy'] = $this->DraftUpdatedBy;
if (isset($this->PackLabel)) $o['PackLabel'] = $this->PackLabel;
if (isset($this->SettingsJson)) $o['SettingsJson'] = $this->SettingsJson;
if (isset($this->Stats)) $o['Stats'] = JsonConverters::to('FormStats', $this->Stats);
if (isset($this->Offered)) $o['Offered'] = JsonConverters::toArray('string', $this->Offered);
if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
return empty($o) ? new class(){} : $o;
}
}
class FormDetail extends FormCard implements JsonSerializable
{
/**
* @param string $FormUID
* @param string|null $Name
* @param string|null $Slug
* @param string|null $Noun
* @param string|null $NumberPrefix
* @param string|null $Description
* @param string|null $Tone
* @param string|null $Status
* @param int|null $PublishedVersionNo
* @param DateTime|null $PublishedAt
* @param string|null $PublishedBy
* @param bool|null $DraftDirty
* @param DateTime|null $DraftUpdatedAt
* @param string|null $DraftUpdatedBy
* @param string|null $PackLabel
* @param string|null $SettingsJson
* @param FormStats|null $Stats
* @param array<string>|null $Offered
* @param string|null $CreatedBy
* @param DateTime|null $CreatedAt
* @param DateTime|null $UpdatedAt
*/
public function __construct(
string $FormUID='',
?string $Name=null,
?string $Slug=null,
?string $Noun=null,
?string $NumberPrefix=null,
?string $Description=null,
?string $Tone=null,
?string $Status=null,
?int $PublishedVersionNo=null,
?DateTime $PublishedAt=null,
?string $PublishedBy=null,
?bool $DraftDirty=null,
?DateTime $DraftUpdatedAt=null,
?string $DraftUpdatedBy=null,
?string $PackLabel=null,
?string $SettingsJson=null,
?FormStats $Stats=null,
?array $Offered=null,
?string $CreatedBy=null,
?DateTime $CreatedAt=null,
?DateTime $UpdatedAt=null,
/** @var string|null */
public ?string $DraftJson=null,
/** @var int */
public int $DraftRev=0,
/** @var string|null */
public ?string $SourceTemplateUID=null,
/** @var array<string>|null */
public ?array $Warnings=null,
/** @var array<string>|null */
public ?array $AlwaysHidden=null
) {
parent::__construct($FormUID,$Name,$Slug,$Noun,$NumberPrefix,$Description,$Tone,$Status,$PublishedVersionNo,$PublishedAt,$PublishedBy,$DraftDirty,$DraftUpdatedAt,$DraftUpdatedBy,$PackLabel,$SettingsJson,$Stats,$Offered,$CreatedBy,$CreatedAt,$UpdatedAt);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['DraftJson'])) $this->DraftJson = $o['DraftJson'];
if (isset($o['DraftRev'])) $this->DraftRev = $o['DraftRev'];
if (isset($o['SourceTemplateUID'])) $this->SourceTemplateUID = $o['SourceTemplateUID'];
if (isset($o['Warnings'])) $this->Warnings = JsonConverters::fromArray('string', $o['Warnings']);
if (isset($o['AlwaysHidden'])) $this->AlwaysHidden = JsonConverters::fromArray('string', $o['AlwaysHidden']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->DraftJson)) $o['DraftJson'] = $this->DraftJson;
if (isset($this->DraftRev)) $o['DraftRev'] = $this->DraftRev;
if (isset($this->SourceTemplateUID)) $o['SourceTemplateUID'] = $this->SourceTemplateUID;
if (isset($this->Warnings)) $o['Warnings'] = JsonConverters::toArray('string', $this->Warnings);
if (isset($this->AlwaysHidden)) $o['AlwaysHidden'] = JsonConverters::toArray('string', $this->AlwaysHidden);
return empty($o) ? new class(){} : $o;
}
}
class FormResponse implements JsonSerializable
{
public function __construct(
/** @var FormDetail|null */
public ?FormDetail $Form=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Form'])) $this->Form = JsonConverters::from('FormDetail', $o['Form']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Form)) $o['Form'] = JsonConverters::to('FormDetail', $this->Form);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class FormUpdateRequest implements JsonSerializable
{
public function __construct(
/** @var string */
public string $FormUID='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Noun=null,
/** @var string|null */
public ?string $Description=null,
/** @var string|null */
public ?string $NumberPrefix=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FormUID'])) $this->FormUID = $o['FormUID'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Noun'])) $this->Noun = $o['Noun'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['NumberPrefix'])) $this->NumberPrefix = $o['NumberPrefix'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FormUID)) $o['FormUID'] = $this->FormUID;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Noun)) $o['Noun'] = $this->Noun;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->NumberPrefix)) $o['NumberPrefix'] = $this->NumberPrefix;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/forms/{FormUID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"FormUID":"00000000000000000000000000000000","Name":"String","Noun":"String","Description":"String","NumberPrefix":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","PublishedBy":"String","DraftDirty":false,"DraftUpdatedAt":"0001-01-01T00:00:00.0000000","DraftUpdatedBy":"String","PackLabel":"String","SettingsJson":"String","Stats":{"Total":0,"NeedDecision":0,"Waiting":0,"Overdue":0},"Offered":["String"],"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}