BctNotification

SendFormsIncompleteEmail

<?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 EmailAddress implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $displayName=null,
        /** @var string|null */
        public ?string $address=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['address'])) $this->address = $o['address'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->address)) $o['address'] = $this->address;
        return empty($o) ? new class(){} : $o;
    }
}

class SendFormsIncompleteEmailResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $result=null,
        /** @var string|null */
        public ?string $subject=null,
        /** @var array<EmailAddress>|null */
        public ?array $toAddresses=null,
        /** @var array<EmailAddress>|null */
        public ?array $ccAddresses=null,
        /** @var array<EmailAddress>|null */
        public ?array $bccAddresses=null,
        /** @var EmailAddress|null */
        public ?EmailAddress $fromAddress=null,
        /** @var int */
        public int $trialEmailCount=0,
        /** @var int */
        public int $emailsSent=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['result'])) $this->result = $o['result'];
        if (isset($o['subject'])) $this->subject = $o['subject'];
        if (isset($o['toAddresses'])) $this->toAddresses = JsonConverters::fromArray('EmailAddress', $o['toAddresses']);
        if (isset($o['ccAddresses'])) $this->ccAddresses = JsonConverters::fromArray('EmailAddress', $o['ccAddresses']);
        if (isset($o['bccAddresses'])) $this->bccAddresses = JsonConverters::fromArray('EmailAddress', $o['bccAddresses']);
        if (isset($o['fromAddress'])) $this->fromAddress = JsonConverters::from('EmailAddress', $o['fromAddress']);
        if (isset($o['trialEmailCount'])) $this->trialEmailCount = $o['trialEmailCount'];
        if (isset($o['emailsSent'])) $this->emailsSent = $o['emailsSent'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->result)) $o['result'] = $this->result;
        if (isset($this->subject)) $o['subject'] = $this->subject;
        if (isset($this->toAddresses)) $o['toAddresses'] = JsonConverters::toArray('EmailAddress', $this->toAddresses);
        if (isset($this->ccAddresses)) $o['ccAddresses'] = JsonConverters::toArray('EmailAddress', $this->ccAddresses);
        if (isset($this->bccAddresses)) $o['bccAddresses'] = JsonConverters::toArray('EmailAddress', $this->bccAddresses);
        if (isset($this->fromAddress)) $o['fromAddress'] = JsonConverters::to('EmailAddress', $this->fromAddress);
        if (isset($this->trialEmailCount)) $o['trialEmailCount'] = $this->trialEmailCount;
        if (isset($this->emailsSent)) $o['emailsSent'] = $this->emailsSent;
        return empty($o) ? new class(){} : $o;
    }
}

class SendFormsIncompleteEmail implements IPost, JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP SendFormsIncompleteEmail DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SendFormsIncompleteEmail HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendFormsIncompleteEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Requests.Hangfire" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendFormsIncompleteEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Requests.Hangfire">
  <BccAddresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:EmailAddress>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:DisplayName>String</d2p1:DisplayName>
    </d2p1:EmailAddress>
  </BccAddresses>
  <CcAddresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:EmailAddress>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:DisplayName>String</d2p1:DisplayName>
    </d2p1:EmailAddress>
  </CcAddresses>
  <EmailsSent>0</EmailsSent>
  <FromAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:Address>String</d2p1:Address>
    <d2p1:DisplayName>String</d2p1:DisplayName>
  </FromAddress>
  <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>
  <Result>String</Result>
  <Subject>String</Subject>
  <ToAddresses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BctNotification.ServiceModel.Types">
    <d2p1:EmailAddress>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:DisplayName>String</d2p1:DisplayName>
    </d2p1:EmailAddress>
  </ToAddresses>
  <TrialEmailCount>0</TrialEmailCount>
</SendFormsIncompleteEmailResponse>