BackofficeApi

<back to all web services

BusinessSearchRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/business/search
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 BackofficeApi


@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


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

GET /business/search HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"businesses":[{"id":0,"name":"String","organizationNumber":"String","postalAddress":"String","postalCode":"String","city":"String","country":"String","contact":{"firstName":"String","lastName":"String","position":"String","phone":"String","email":"String"}}],"total":0,"size":0,"offset":0}