BokaMera.API.Host

<back to all web services

UploadImagesRequest

The following routes are available for this service:
POST/images
<?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 UploadImageResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $FilePath=null
    ) {
    }

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

class UploadImagesRequest implements 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 1 - LogoType ,2 - Homepage, 3 - Newsletter, 4 - Resource, 5 - Service, 6 - Customer comments, 7 - Support Case Attachments */
        // @ApiMember(Description="1 - LogoType ,2 - Homepage, 3 - Newsletter, 4 - Resource, 5 - Service, 6 - Customer comments, 7 - Support Case Attachments", IsRequired=true, ParameterType="query")
        /** @var int */
        public int $FolderType=0
    ) {
    }

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

PHP UploadImagesRequest 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 /images HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadImagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <FolderType>0</FolderType>
</UploadImagesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UploadImageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <FilePath>String</FilePath>
</UploadImageResponse>