BokaMera.API.Host

<back to all web services

DashboardMessageQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/messages/dashboardSearch the dashboard messages for any messages.Search the dashboard messages for any messages.
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 QueryBase:
    skip: Optional[int] = None
    """
    Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
    """

    take: Optional[int] = None
    """
    Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
    """

    order_by: Optional[str] = None
    """
    Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
    """

    order_by_desc: Optional[str] = None
    """
    Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
    """

    include: Optional[str] = None
    """
    Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
    """

    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


From = TypeVar('From')
Into = TypeVar('Into')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb2(Generic[From, Into], QueryBase, IReturn[QueryResponse[Into]]):
    @staticmethod
    def response_type(): return QueryResponse[Into]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DasboardMessageTypeResponse:
    # @ApiMember(Description="The message type id")
    id: int = 0
    """
    The message type id
    """


    # @ApiMember(Description="The message type name")
    name: Optional[str] = None
    """
    The message type name
    """


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


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


    # @ApiMember(Description="If the message type is a application message")
    application_message: Optional[bool] = None
    """
    If the message type is a application message
    """


    # @ApiMember(Description="The message type icon")
    icon: Optional[str] = None
    """
    The message type icon
    """


    # @ApiMember(Description="The message type color")
    color: Optional[str] = None
    """
    The message type color
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardMessageQueryResponse:
    # @ApiMember(Description="The message id")
    id: int = 0
    """
    The message id
    """


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


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


    # @ApiMember(Description="If the message is important.")
    important: bool = False
    """
    If the message is important.
    """


    # @ApiMember(Description="If the message visible from date.")
    visible_from: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    If the message visible from date.
    """


    # @ApiMember(Description="If the message visible to date.")
    visible_to: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    If the message visible to date.
    """


    # @ApiMember(Description="If the message created date.")
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    If the message created date.
    """


    # @ApiMember(Description="If the message type id.")
    message_type_id: int = 0
    """
    If the message type id.
    """


    # @ApiMember(Description="If the message is connected to a support case.")
    support_case_id: Optional[int] = None
    """
    If the message is connected to a support case.
    """


    # @ApiMember(Description="If the message type information.")
    message_type: Optional[DasboardMessageTypeResponse] = None
    """
    If the message type information.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardMessageType(BaseModel):
    # @Required()
    name: Optional[str] = None

    # @Required()
    description: Optional[str] = None

    # @Required()
    image: Optional[str] = None

    application_message: Optional[bool] = None
    # @Required()
    color: Optional[str] = None

    # @Required()
    icon: Optional[str] = None

    modified_date: Optional[datetime.datetime] = None
    id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardMessage(BaseModel):
    # @References(typeof(DashboardMessageType))
    message_type_id: int = 0

    message_type: Optional[DashboardMessageType] = None
    # @Required()
    company_id: Optional[str] = None

    id: int = 0
    # @Required()
    title: Optional[str] = None

    # @Required()
    body: Optional[str] = None

    # @Required()
    important: bool = False

    # @Required()
    visible_from: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    visible_to: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    created: datetime.datetime = datetime.datetime(1, 1, 1)

    support_case_id: Optional[int] = None
    modified_date: Optional[datetime.datetime] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardMessageQuery(QueryDb2[DashboardMessage, DashboardMessageQueryResponse], ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(DataType="boolean", Description="If you want to filter on important messages only", ParameterType="query")
    important: Optional[bool] = None
    """
    If you want to filter on important messages only
    """


    # @ApiMember(DataType="int", Description="Filter on Message Type Id", ParameterType="query")
    message_type_id: Optional[int] = None
    """
    Filter on Message Type Id
    """


    # @ApiMember(DataType="boolean", Description="If you want to include the message type information", ParameterType="query")
    include_message_type_information: bool = False
    """
    If you want to include the message type information
    """


    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
    id: int = 0
    key_type: Optional[str] = None
    description: Optional[str] = None


AccessKeyTypeResponse = TypeVar('AccessKeyTypeResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[AccessKeyTypeResponse]):
    offset: int = 0
    total: int = 0
    results: Optional[List[AccessKeyTypeResponse]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python DashboardMessageQuery DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /messages/dashboard HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Title":"String","Body":"String","Important":false,"MessageTypeId":0,"SupportCaseId":0,"MessageType":{"Id":0,"Name":"String","Description":"String","ImageUrl":"String","ApplicationMessage":false,"Icon":"String","Color":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}