BokaMera.API.Host

<back to all web services

CreateHomepageImage

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/homepage/imagesAdd a new homepage imageAdd a new homepage image to the company of the currently logged in user, only administrators are allowed to add support cases.
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 HomepageImageQueryResponse:
    # @ApiMember(Description="The company id.")
    company_id: Optional[str] = None
    """
    The company id.
    """


    # @ApiMember(Description="The homepage image id.")
    id: int = 0
    """
    The homepage image id.
    """


    # @ApiMember(Description="The image title.")
    title: Optional[str] = None
    """
    The image title.
    """


    # @ApiMember(Description="The image description.")
    description: Optional[str] = None
    """
    The image description.
    """


    # @ApiMember(Description="The image url.")
    image_url: Optional[str] = None
    """
    The image url.
    """


# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateHomepageImage(ICompany):
    # @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
    company_id: Optional[str] = None
    """
    Enter the company id, if blank company id and you are an admin, your company id will be used.
    """


    # @ApiMember(Description="The image title.")
    title: Optional[str] = None
    """
    The image title.
    """


    # @ApiMember(Description="The image description.")
    description: Optional[str] = None
    """
    The image description.
    """


    # @ApiMember(Description="The image url.")
    image_url: Optional[str] = None
    """
    The image url.
    """

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

POST /homepage/images HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Title":"String","Description":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"Title":"String","Description":"String"}