regis

LetterSentRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/correspondence

<?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 LetterSentResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $document_name=null,
        /** @var string|null */
        public ?string $document_description=null,
        /** @var string|null */
        public ?string $program=null,
        /** @var string|null */
        public ?string $letter_status=null,
        /** @var string|null */
        public ?string $application_status=null,
        /** @var DateTime|null */
        public ?DateTime $application_date=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['document_name'])) $this->document_name = $o['document_name'];
        if (isset($o['document_description'])) $this->document_description = $o['document_description'];
        if (isset($o['program'])) $this->program = $o['program'];
        if (isset($o['letter_status'])) $this->letter_status = $o['letter_status'];
        if (isset($o['application_status'])) $this->application_status = $o['application_status'];
        if (isset($o['application_date'])) $this->application_date = JsonConverters::from('DateTime', $o['application_date']);
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->document_name)) $o['document_name'] = $this->document_name;
        if (isset($this->document_description)) $o['document_description'] = $this->document_description;
        if (isset($this->program)) $o['program'] = $this->program;
        if (isset($this->letter_status)) $o['letter_status'] = $this->letter_status;
        if (isset($this->application_status)) $o['application_status'] = $this->application_status;
        if (isset($this->application_date)) $o['application_date'] = JsonConverters::to('DateTime', $this->application_date);
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        return empty($o) ? new class(){} : $o;
    }
}

class LetterSentRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $pid=0
    ) {
    }

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

PHP LetterSentRequest 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 /correspondence HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LetterSentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <pid>0</pid>
</LetterSentRequest>

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

<LetterSentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <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>
  <added_date>0001-01-01T00:00:00</added_date>
  <application_date>0001-01-01T00:00:00</application_date>
  <application_status>String</application_status>
  <document_description>String</document_description>
  <document_name>String</document_name>
  <letter_status>String</letter_status>
  <program>String</program>
  <regent_id>0</regent_id>
</LetterSentResponse>