| POST | /v1/formfill/draft/{Token}/sign/{FieldKey} |
|---|
<?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 FormFillFieldError implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $K=null,
/** @var string|null */
public ?string $Msg=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['K'])) $this->K = $o['K'];
if (isset($o['Msg'])) $this->Msg = $o['Msg'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->K)) $o['K'] = $this->K;
if (isset($this->Msg)) $o['Msg'] = $this->Msg;
return empty($o) ? new class(){} : $o;
}
}
class FormFillSignResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Mode=null,
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $At=null,
/** @var string|null */
public ?string $Id=null,
/** @var string|null */
public ?string $Hash=null,
/** @var int */
public int $Rev=0,
/** @var array<FormFillFieldError>|null */
public ?array $Errors=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Mode'])) $this->Mode = $o['Mode'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['At'])) $this->At = $o['At'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Hash'])) $this->Hash = $o['Hash'];
if (isset($o['Rev'])) $this->Rev = $o['Rev'];
if (isset($o['Errors'])) $this->Errors = JsonConverters::fromArray('FormFillFieldError', $o['Errors']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Mode)) $o['Mode'] = $this->Mode;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->At)) $o['At'] = $this->At;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Hash)) $o['Hash'] = $this->Hash;
if (isset($this->Rev)) $o['Rev'] = $this->Rev;
if (isset($this->Errors)) $o['Errors'] = JsonConverters::toArray('FormFillFieldError', $this->Errors);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class FormFillSignRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Token=null,
/** @var string|null */
public ?string $FieldKey=null,
/** @var string|null */
public ?string $AnswersJson=null,
/** @var int */
public int $Page=0,
/** @var string|null */
public ?string $Lang=null,
/** @var int|null */
public ?int $Rev=null,
/** @var string|null */
public ?string $Mode=null,
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Png=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Token'])) $this->Token = $o['Token'];
if (isset($o['FieldKey'])) $this->FieldKey = $o['FieldKey'];
if (isset($o['AnswersJson'])) $this->AnswersJson = $o['AnswersJson'];
if (isset($o['Page'])) $this->Page = $o['Page'];
if (isset($o['Lang'])) $this->Lang = $o['Lang'];
if (isset($o['Rev'])) $this->Rev = $o['Rev'];
if (isset($o['Mode'])) $this->Mode = $o['Mode'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Png'])) $this->Png = $o['Png'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Token)) $o['Token'] = $this->Token;
if (isset($this->FieldKey)) $o['FieldKey'] = $this->FieldKey;
if (isset($this->AnswersJson)) $o['AnswersJson'] = $this->AnswersJson;
if (isset($this->Page)) $o['Page'] = $this->Page;
if (isset($this->Lang)) $o['Lang'] = $this->Lang;
if (isset($this->Rev)) $o['Rev'] = $this->Rev;
if (isset($this->Mode)) $o['Mode'] = $this->Mode;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Png)) $o['Png'] = $this->Png;
return empty($o) ? new class(){} : $o;
}
}
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/formfill/draft/{Token}/sign/{FieldKey} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormFillSignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AnswersJson>String</AnswersJson>
<FieldKey>String</FieldKey>
<Lang>String</Lang>
<Mode>String</Mode>
<Name>String</Name>
<Page>0</Page>
<Png>String</Png>
<Rev>0</Rev>
<Token>String</Token>
</FormFillSignRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormFillSignResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<At>String</At>
<Errors>
<FormFillFieldError>
<K>String</K>
<Msg>String</Msg>
</FormFillFieldError>
</Errors>
<Hash>String</Hash>
<Id>String</Id>
<Mode>String</Mode>
<Name>String</Name>
<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>
<Rev>0</Rev>
</FormFillSignResponse>