BokaMera.API.Host

<back to all web services

CreateError

The following routes are available for this service:
POST/errors/Save error to log
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 ErrorQueryResponse:
    company_id: Optional[str] = None
    id: int = 0
    exception_name: Optional[str] = None
    exception_message: Optional[str] = None
    exception_source: Optional[str] = None
    inner_exception_name: Optional[str] = None
    stack_trace: Optional[str] = None
    url: Optional[str] = None
    logged_in_user: Optional[str] = None
    visible: bool = False
    ip_address: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    request: Optional[str] = None
    session: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateError(ICompany):
    # @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="", IsRequired=true)
    exception_name: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="", IsRequired=true)
    exception_message: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="")
    exception_source: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="", IsRequired=true)
    inner_exception_name: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="", IsRequired=true)
    stack_trace: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="", IsRequired=true)
    url: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="")
    logged_in_user: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="")
    ip_address: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="")
    request: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="")
    session: Optional[str] = None
    """
    
    """

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

<CreateError 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>
  <ExceptionMessage>String</ExceptionMessage>
  <ExceptionName>String</ExceptionName>
  <ExceptionSource>String</ExceptionSource>
  <IPAddress>String</IPAddress>
  <InnerExceptionName>String</InnerExceptionName>
  <LoggedInUser>String</LoggedInUser>
  <Request>String</Request>
  <Session>String</Session>
  <StackTrace>String</StackTrace>
  <URL>String</URL>
</CreateError>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ErrorQueryResponse 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>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <ExceptionMessage>String</ExceptionMessage>
  <ExceptionName>String</ExceptionName>
  <ExceptionSource>String</ExceptionSource>
  <IPAddress>String</IPAddress>
  <Id>0</Id>
  <InnerExceptionName>String</InnerExceptionName>
  <LoggedInUser>String</LoggedInUser>
  <Request>String</Request>
  <Session>String</Session>
  <StackTrace>String</StackTrace>
  <URL>String</URL>
  <Visible>false</Visible>
</ErrorQueryResponse>