BokaMera.API.Host

<back to all web services

DeleteNewsItem

<?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 NewsItemQueryResponse implements JsonSerializable
{
    public function __construct(
        /** @description The news item id */
        // @ApiMember(Description="The news item id")
        /** @var int */
        public int $Id=0,

        /** @description Heading of the news item */
        // @ApiMember(Description="Heading of the news item")
        /** @var string|null */
        public ?string $Heading=null,

        /** @description Body of the news item */
        // @ApiMember(Description="Body of the news item")
        /** @var string|null */
        public ?string $Body=null,

        /** @description Url to a image associated with the news */
        // @ApiMember(Description="Url to a image associated with the news")
        /** @var string|null */
        public ?string $ImageUrl=null,

        /** @description The timestamp from which the newsitem should be visible from */
        // @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
        /** @var DateTime */
        public DateTime $From=new DateTime(),

        /** @description The timestamp to which the newsitem should be visible to */
        // @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
        /** @var DateTime */
        public DateTime $To=new DateTime(),

        /** @description The timestamp when news was created */
        // @ApiMember(Description="The timestamp when news was created", IsRequired=true)
        /** @var DateTime */
        public DateTime $Created=new DateTime(),

        /** @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['Heading'])) $this->Heading = $o['Heading'];
        if (isset($o['Body'])) $this->Body = $o['Body'];
        if (isset($o['ImageUrl'])) $this->ImageUrl = JsonConverters::from('string', $o['ImageUrl']);
        if (isset($o['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
        if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
        if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
        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->Heading)) $o['Heading'] = $this->Heading;
        if (isset($this->Body)) $o['Body'] = $this->Body;
        if (isset($this->ImageUrl)) $o['ImageUrl'] = JsonConverters::to('string', $this->ImageUrl);
        if (isset($this->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
        if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
        if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @ValidateRequest(Validator="IsAuthenticated")
class DeleteNewsItem implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description Id of the newsitem to delete */
        // @ApiMember(Description="Id of the newsitem to delete", IsRequired=true)
        /** @var int */
        public int $Id=0
    ) {
    }

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

PHP DeleteNewsItem DTOs

DELETE /news/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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