Client_Initiations

DocumentUploadRequest

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

<?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 DocumentUploadResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $FileName=null,
        /** @var string|null */
        public ?string $DownloadLink=null,
        /** @var string|null */
        public ?string $ListLink=null,
        /** @var int */
        public int $DaysToLive=0,
        /** @var string|null */
        public ?string $Message=null,
        /** @var bool|null */
        public ?bool $IsSuccess=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
        if (isset($o['DownloadLink'])) $this->DownloadLink = $o['DownloadLink'];
        if (isset($o['ListLink'])) $this->ListLink = $o['ListLink'];
        if (isset($o['DaysToLive'])) $this->DaysToLive = $o['DaysToLive'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
        if (isset($o['IsSuccess'])) $this->IsSuccess = $o['IsSuccess'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        if (isset($this->DownloadLink)) $o['DownloadLink'] = $this->DownloadLink;
        if (isset($this->ListLink)) $o['ListLink'] = $this->ListLink;
        if (isset($this->DaysToLive)) $o['DaysToLive'] = $this->DaysToLive;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        if (isset($this->IsSuccess)) $o['IsSuccess'] = $this->IsSuccess;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @ApiResponse(Description="Returned if a client is not authorized to upload a receipt", StatusCode=401)
// @ApiResponse(Description="Returned if the validation failed for the input expense receipt", StatusCode=412)
// @ApiResponse(Description="Returned if the corresponding expense report was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the call to the expense service failed", StatusCode=400)
class DocumentUploadRequest implements IPost, JsonSerializable
{
    public function __construct(
        /** @description FileName */
        // @ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
        /** @var string */
        public string $FileName='',

        /** @description ExternalID */
        // @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
        /** @var string */
        public string $ExternalId='',

        /** @description RequestStream needs to be base64 file content */
        // @ApiMember(Description="RequestStream needs to be base64 file content")
        /** @var string|null */
        public ?string $RequestStream=null
    ) {
    }

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

PHP DocumentUploadRequest 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 /documents HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <ExternalId>String</ExternalId>
  <FileName>String</FileName>
  <RequestStream>String</RequestStream>
</DocumentUploadRequest>

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

<DocumentUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <DaysToLive>0</DaysToLive>
  <DownloadLink>String</DownloadLink>
  <FileName>String</FileName>
  <IsSuccess>false</IsSuccess>
  <ListLink>String</ListLink>
  <Message>String</Message>
  <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>
</DocumentUploadResponse>