BusinessApi

<back to all web services

UserStatusRequest

Business
The following routes are available for this service:
GET/user/status
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

# module BusinessApi


class Locale(str, Enum):
    EN_US = 'EnUs'
    NB_NO = 'NbNo'


class BusinessRole(str, Enum):
    OWNER = 'Owner'
    MANAGER = 'Manager'
    SALES = 'Sales'
    MARKETING = 'Marketing'
    OTHER = 'Other'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessContact:
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    position: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OpeningHour:
    open_at_hour: int = 0
    open_at_minute: int = 0
    close_at_hour: int = 0
    close_at_minute: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WeeklyOpeningHours:
    monday: Optional[OpeningHour] = None
    tuesday: Optional[OpeningHour] = None
    wednesday: Optional[OpeningHour] = None
    thursday: Optional[OpeningHour] = None
    friday: Optional[OpeningHour] = None
    saturday: Optional[OpeningHour] = None
    sunday: Optional[OpeningHour] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OpeningHours:
    weekly: Optional[WeeklyOpeningHours] = None


class PlaceType(str, Enum):
    MALL = 'Mall'
    REGULAR = 'Regular'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlaceContact:
    phone: Optional[str] = None
    email: Optional[str] = None
    website: Optional[str] = None
    web_shop: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlaceAddress:
    street: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TimeZoneDto:
    base_utc_offset: datetime.timedelta = datetime.timedelta()
    daylight_name: Optional[str] = None
    display_name: Optional[str] = None
    id: Optional[str] = None
    standard_name: Optional[str] = None
    supports_daylight_saving_time: bool = False


class PriceMainDish(str, Enum):
    VALUE = 'Value'
    MEDIUM = 'Medium'
    HIGH = 'High'
    FINE_DINING = 'FineDining'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PriceMainDishDto:
    title: Optional[str] = None
    slug: Optional[PriceMainDish] = None


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

GET /user/status HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Businesses>
    <BusinessDto>
      <City>String</City>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Email>String</d4p1:Email>
        <d4p1:FirstName>String</d4p1:FirstName>
        <d4p1:LastName>String</d4p1:LastName>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:Position>String</d4p1:Position>
      </Contact>
      <Country>String</Country>
      <Id>0</Id>
      <Name>String</Name>
      <OrganizationNumber>String</OrganizationNumber>
      <PostalCode>String</PostalCode>
      <StreetAddress>String</StreetAddress>
    </BusinessDto>
  </Businesses>
  <Invitations>
    <StaffInvitationDto>
      <BusinessId>0</BusinessId>
      <BusinessName>String</BusinessName>
      <BusinessRole>Owner</BusinessRole>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <InviteKey>String</InviteKey>
      <LastName>String</LastName>
      <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
      <PlaceId>0</PlaceId>
      <PlaceName>String</PlaceName>
      <Role>Owner</Role>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UserId>0</UserId>
    </StaffInvitationDto>
  </Invitations>
  <Places>
    <PlaceBasicDto>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:CountryCode>String</d4p1:CountryCode>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:Street>String</d4p1:Street>
      </Address>
      <BusinessId>0</BusinessId>
      <Claimed>false</Claimed>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Email>String</d4p1:Email>
        <d4p1:Phone>String</d4p1:Phone>
        <d4p1:WebShop>String</d4p1:WebShop>
        <d4p1:Website>String</d4p1:Website>
      </Contact>
      <CountryCode>String</CountryCode>
      <Floor>String</Floor>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
      <OpeningHours xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Weekly>
          <d4p1:Friday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Friday>
          <d4p1:Monday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Monday>
          <d4p1:Saturday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Saturday>
          <d4p1:Sunday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Sunday>
          <d4p1:Thursday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Thursday>
          <d4p1:Tuesday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Tuesday>
          <d4p1:Wednesday>
            <d4p1:CloseAtHour>0</d4p1:CloseAtHour>
            <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute>
            <d4p1:OpenAtHour>0</d4p1:OpenAtHour>
            <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute>
          </d4p1:Wednesday>
        </d4p1:Weekly>
      </OpeningHours>
      <OrganizationNumber>String</OrganizationNumber>
      <OtherServices>
        <MallOtherServiceDto>
          <Floor>String</Floor>
          <Id>0</Id>
          <ServiceName>String</ServiceName>
        </MallOtherServiceDto>
      </OtherServices>
      <OutdoorSeating>false</OutdoorSeating>
      <Overview>String</Overview>
      <PlaceType>Mall</PlaceType>
      <PriceMainDish xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Slug>Value</d4p1:Slug>
        <d4p1:Title>String</d4p1:Title>
      </PriceMainDish>
      <SaveFoodAndMoney>false</SaveFoodAndMoney>
      <TimeZoneDto xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:BaseUtcOffset>PT0S</d4p1:BaseUtcOffset>
        <d4p1:DaylightName>String</d4p1:DaylightName>
        <d4p1:DisplayName>String</d4p1:DisplayName>
        <d4p1:Id>String</d4p1:Id>
        <d4p1:StandardName>String</d4p1:StandardName>
        <d4p1:SupportsDaylightSavingTime>false</d4p1:SupportsDaylightSavingTime>
      </TimeZoneDto>
      <WheelChairAccessible>false</WheelChairAccessible>
      <Wifi>false</Wifi>
    </PlaceBasicDto>
  </Places>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Status>SignInOrUp</Status>
  <UserDto>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <Id>0</Id>
    <LastName>String</LastName>
    <LegalIdentityVerified>false</LegalIdentityVerified>
    <Locale>EnUs</Locale>
    <MobilePhone>String</MobilePhone>
  </UserDto>
</UserStatusResponse>