BokaMera.API.Host

<back to all web services

UploadImagesRequest

The following routes are available for this service:
POST/images
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadImageResponse:
    file_path: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadImagesRequest:
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="1 - LogoType ,2 - Homepage, 3 - Newsletter, 4 - Resource, 5 - Service, 6 - Customer comments, 7 - Support Case Attachments", IsRequired=true, ParameterType="query")
    folder_type: int = 0
    """
    1 - LogoType ,2 - Homepage, 3 - Newsletter, 4 - Resource, 5 - Service, 6 - Customer comments, 7 - Support Case Attachments
    """

Python 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>