| GET,POST | /v1/witness/notary/invite |
|---|
<?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 NotaryInvitePreview implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Link=null,
/** @var string|null */
public ?string $Subject=null,
/** @var string|null */
public ?string $Greeting=null,
/** @var string|null */
public ?string $Lead=null,
/** @var string|null */
public ?string $SignIn=null,
/** @var string|null */
public ?string $Sms=null,
/** @var int */
public int $SmsLength=0,
/** @var int */
public int $SmsSegments=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Link'])) $this->Link = $o['Link'];
if (isset($o['Subject'])) $this->Subject = $o['Subject'];
if (isset($o['Greeting'])) $this->Greeting = $o['Greeting'];
if (isset($o['Lead'])) $this->Lead = $o['Lead'];
if (isset($o['SignIn'])) $this->SignIn = $o['SignIn'];
if (isset($o['Sms'])) $this->Sms = $o['Sms'];
if (isset($o['SmsLength'])) $this->SmsLength = $o['SmsLength'];
if (isset($o['SmsSegments'])) $this->SmsSegments = $o['SmsSegments'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Link)) $o['Link'] = $this->Link;
if (isset($this->Subject)) $o['Subject'] = $this->Subject;
if (isset($this->Greeting)) $o['Greeting'] = $this->Greeting;
if (isset($this->Lead)) $o['Lead'] = $this->Lead;
if (isset($this->SignIn)) $o['SignIn'] = $this->SignIn;
if (isset($this->Sms)) $o['Sms'] = $this->Sms;
if (isset($this->SmsLength)) $o['SmsLength'] = $this->SmsLength;
if (isset($this->SmsSegments)) $o['SmsSegments'] = $this->SmsSegments;
return empty($o) ? new class(){} : $o;
}
}
class NotaryInviteResponse implements JsonSerializable
{
public function __construct(
/** @var NotaryInvitePreview|null */
public ?NotaryInvitePreview $Preview=null,
/** @var array<string>|null */
public ?array $Lines=null,
/** @var string|null */
public ?string $EmailedTo=null,
/** @var string|null */
public ?string $TextedTo=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Preview'])) $this->Preview = JsonConverters::from('NotaryInvitePreview', $o['Preview']);
if (isset($o['Lines'])) $this->Lines = JsonConverters::fromArray('string', $o['Lines']);
if (isset($o['EmailedTo'])) $this->EmailedTo = $o['EmailedTo'];
if (isset($o['TextedTo'])) $this->TextedTo = $o['TextedTo'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Preview)) $o['Preview'] = JsonConverters::to('NotaryInvitePreview', $this->Preview);
if (isset($this->Lines)) $o['Lines'] = JsonConverters::toArray('string', $this->Lines);
if (isset($this->EmailedTo)) $o['EmailedTo'] = $this->EmailedTo;
if (isset($this->TextedTo)) $o['TextedTo'] = $this->TextedTo;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class NotaryInviteRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Email=null,
/** @var string|null */
public ?string $Phone=null,
/** @var int|null */
public ?int $NotaryId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['Phone'])) $this->Phone = $o['Phone'];
if (isset($o['NotaryId'])) $this->NotaryId = $o['NotaryId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->Phone)) $o['Phone'] = $this->Phone;
if (isset($this->NotaryId)) $o['NotaryId'] = $this->NotaryId;
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/witness/notary/invite HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NotaryInviteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Email>String</Email>
<NotaryId>0</NotaryId>
<Phone>String</Phone>
</NotaryInviteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NotaryInviteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<EmailedTo>String</EmailedTo>
<Lines xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Lines>
<Preview>
<Greeting>String</Greeting>
<Lead>String</Lead>
<Link>String</Link>
<SignIn>String</SignIn>
<Sms>String</Sms>
<SmsLength>0</SmsLength>
<SmsSegments>0</SmsSegments>
<Subject>String</Subject>
</Preview>
<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>
<TextedTo>String</TextedTo>
</NotaryInviteResponse>