| POST,OPTIONS | /v1/additionalservice/{Id}/send |
|---|
<?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 AdditionalServiceSendResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var bool|null */
public ?bool $Success=null,
/** @var string|null */
public ?string $PortalUrl=null,
/** @var array<string>|null */
public ?array $DeliveryErrors=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Success'])) $this->Success = $o['Success'];
if (isset($o['PortalUrl'])) $this->PortalUrl = $o['PortalUrl'];
if (isset($o['DeliveryErrors'])) $this->DeliveryErrors = JsonConverters::fromArray('string', $o['DeliveryErrors']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Success)) $o['Success'] = $this->Success;
if (isset($this->PortalUrl)) $o['PortalUrl'] = $this->PortalUrl;
if (isset($this->DeliveryErrors)) $o['DeliveryErrors'] = JsonConverters::toArray('string', $this->DeliveryErrors);
return empty($o) ? new class(){} : $o;
}
}
class AdditionalServiceSendRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $Title=null,
/** @var float|null */
public ?float $Amount=null,
/** @var bool|null */
public ?bool $PriceTbd=null,
/** @var int|null */
public ?int $RecipientContactId=null,
/** @var string|null */
public ?string $RecipientEmail=null,
/** @var string|null */
public ?string $RecipientPhone=null,
/** @var bool|null */
public ?bool $DeliverEmail=null,
/** @var bool|null */
public ?bool $DeliverSms=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Title'])) $this->Title = $o['Title'];
if (isset($o['Amount'])) $this->Amount = $o['Amount'];
if (isset($o['PriceTbd'])) $this->PriceTbd = $o['PriceTbd'];
if (isset($o['RecipientContactId'])) $this->RecipientContactId = $o['RecipientContactId'];
if (isset($o['RecipientEmail'])) $this->RecipientEmail = $o['RecipientEmail'];
if (isset($o['RecipientPhone'])) $this->RecipientPhone = $o['RecipientPhone'];
if (isset($o['DeliverEmail'])) $this->DeliverEmail = $o['DeliverEmail'];
if (isset($o['DeliverSms'])) $this->DeliverSms = $o['DeliverSms'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Title)) $o['Title'] = $this->Title;
if (isset($this->Amount)) $o['Amount'] = $this->Amount;
if (isset($this->PriceTbd)) $o['PriceTbd'] = $this->PriceTbd;
if (isset($this->RecipientContactId)) $o['RecipientContactId'] = $this->RecipientContactId;
if (isset($this->RecipientEmail)) $o['RecipientEmail'] = $this->RecipientEmail;
if (isset($this->RecipientPhone)) $o['RecipientPhone'] = $this->RecipientPhone;
if (isset($this->DeliverEmail)) $o['DeliverEmail'] = $this->DeliverEmail;
if (isset($this->DeliverSms)) $o['DeliverSms'] = $this->DeliverSms;
return empty($o) ? new class(){} : $o;
}
}
PHP AdditionalServiceSendRequest 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/additionalservice/{Id}/send HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AdditionalServiceSendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Amount>0</Amount>
<DeliverEmail>false</DeliverEmail>
<DeliverSms>false</DeliverSms>
<Id>0</Id>
<PriceTbd>false</PriceTbd>
<RecipientContactId>0</RecipientContactId>
<RecipientEmail>String</RecipientEmail>
<RecipientPhone>String</RecipientPhone>
<Title>String</Title>
</AdditionalServiceSendRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AdditionalServiceSendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DeliveryErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DeliveryErrors>
<PortalUrl>String</PortalUrl>
<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>
<Success>false</Success>
</AdditionalServiceSendResponse>