digitaluapi

<back to all web services

TenantImagesEdit

The following routes are available for this service:
PUT/tenant_images/{Id}
<?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};


// @DataContract
class IdResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $Id=null,

        // @DataMember(Order=2)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

// @DataContract
/**
 * @template IUpdateDb of TenantImages
 */
class TenantImagesEdit implements IPut, IUpdateDb, JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $FileName=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $FileType=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $FileExtension=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $UploadUrl=null,

        // @DataMember(Order=6)
        /** @var int */
        public int $TenantId=0,

        // @DataMember(Order=7)
        /** @var bool|null */
        public ?bool $IsEnabled=null
    ) {
    }

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

PHP TenantImagesEdit DTOs

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

HTTP + JSV

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

PUT /tenant_images/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	FileName: String,
	FileType: String,
	FileExtension: String,
	UploadUrl: String,
	TenantId: 0,
	IsEnabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}