regis

<back to all web services

TaxReceiptListRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TaxReceipt/{uuid}/List
<?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 TaxReceiptResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $is_t4a=null,
        /** @var bool|null */
        public ?bool $is_t2202a=null,
        /** @var int */
        public int $year=0,
        /** @var string|null */
        public ?string $url=null
    ) {
    }

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

class TaxReceiptsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var bool|null */
        public ?bool $is_missing_tax_number=null,
        /** @var array<TaxReceiptResponse>|null */
        public ?array $receipts=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['is_missing_tax_number'])) $this->is_missing_tax_number = $o['is_missing_tax_number'];
        if (isset($o['receipts'])) $this->receipts = JsonConverters::fromArray('TaxReceiptResponse', $o['receipts']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->is_missing_tax_number)) $o['is_missing_tax_number'] = $this->is_missing_tax_number;
        if (isset($this->receipts)) $o['receipts'] = JsonConverters::toArray('TaxReceiptResponse', $this->receipts);
        return empty($o) ? new class(){} : $o;
    }
}

class TaxReceiptListRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null
    ) {
    }

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

PHP TaxReceiptListRequest 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 /TaxReceipt/{uuid}/List HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TaxReceiptListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</TaxReceiptListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TaxReceiptsResponse 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>
  <is_missing_tax_number>false</is_missing_tax_number>
  <receipts>
    <TaxReceiptResponse>
      <is_t2202a>false</is_t2202a>
      <is_t4a>false</is_t4a>
      <url>String</url>
      <year>0</year>
    </TaxReceiptResponse>
  </receipts>
</TaxReceiptsResponse>