BokaMera.API.Host

<back to all web services

DeleteSupportCaseComment

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/support/cases/{SupportCaseId}/comments/{Id}Delete a case commentDelete a support case comment logged in user, only administrators are allowed to delete support case comments.
<?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 SupportCaseCommentsResponse implements JsonSerializable
{
    public function __construct(
        /** @description The case id */
        // @ApiMember(Description="The case id")
        /** @var int */
        public int $SupportCaseId=0,

        /** @description The comments id */
        // @ApiMember(Description="The comments id")
        /** @var int */
        public int $Id=0,

        /** @description The case comment */
        // @ApiMember(Description="The case comment")
        /** @var string|null */
        public ?string $Comment=null,

        /** @description The case comment created by */
        // @ApiMember(Description="The case comment created by")
        /** @var string|null */
        public ?string $CreatedBy=null,

        /** @description The case comment created date */
        // @ApiMember(Description="The case comment created date")
        /** @var DateTime */
        public DateTime $Created=new DateTime()
    ) {
    }

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

// @ValidateRequest(Validator="IsAuthenticated")
class DeleteSupportCaseComment implements ISupportCase, JsonSerializable
{
    public function __construct(
        /** @description Enter the company id, if blank company id and you are an admin, your company id will be used. */
        // @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
        /** @var string */
        public string $CompanyId='',

        /** @description The support case id */
        // @ApiMember(Description="The support case id", ParameterType="path")
        /** @var int */
        public int $SupportCaseId=0,

        /** @description The support case comment id */
        // @ApiMember(Description="The support case comment id", ParameterType="path")
        /** @var int */
        public int $Id=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['SupportCaseId'])) $this->SupportCaseId = $o['SupportCaseId'];
        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->SupportCaseId)) $o['SupportCaseId'] = $this->SupportCaseId;
        if (isset($this->Id)) $o['Id'] = $this->Id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DeleteSupportCaseComment DTOs

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

HTTP + OTHER

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

DELETE /support/cases/{SupportCaseId}/comments/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"SupportCaseId":0,"Id":0,"Comment":"String","CreatedBy":"String"}