BokaMera.API.Host

<back to all web services

CheckSitePathValid

The following routes are available for this service:
GET/companies/checksitepathvalidCheck if company with sitepath is validThis service is used to check if sitepath on company is valid (free and correct).
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 CheckCompanySitePathIsValidResponse:
    valid: bool = False
    message: Optional[str] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckSitePathValid:
    # @ApiMember(Description="The sitepath to the company.")
    site_path: Optional[str] = None
    """
    The sitepath to the company.
    """

Python CheckSitePathValid DTOs

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

HTTP + JSV

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

GET /companies/checksitepathvalid HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Valid: False,
	Message: String
}