BokaMera.API.Host

<back to all web services

SuperAdminAddSupportCaseAttachment

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
POST/superadmin/support/cases/{Id}/attachmentsAdd a new support case commentAdd a new support case attachment as image to the support case with the prvoided id for the currently logged in user, only administrators are allowed to add support cases.
<?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 SupportCaseAttachmentResponse implements JsonSerializable
{
    public function __construct(
        /** @description The attachment id */
        // @ApiMember(Description="The attachment id")
        /** @var int */
        public int $Id=0,

        /** @description The attachment file url */
        // @ApiMember(Description="The attachment file url")
        /** @var string|null */
        public ?string $FileUrl=null
    ) {
    }

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
class SuperAdminAddSupportCaseAttachment 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 $Id=0,

        /** @description The case attachment url. Only images are allowed to attach. */
        // @ApiMember(Description="The case attachment url. Only images are allowed to attach.")
        /** @var string|null */
        public ?string $FileUrl=null
    ) {
    }

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

PHP SuperAdminAddSupportCaseAttachment DTOs

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

HTTP + CSV

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

POST /superadmin/support/cases/{Id}/attachments HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"FileUrl":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"FileUrl":"String"}