BokaMera.API.Host

<back to all web services

NewsletterCustomerQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/newsletter/customersGet all customers that are valid for sending newsletters to.Get all customers that are valid for sending newsletters to.
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 NewsletterCustomerInfo:
    id: Optional[str] = None
    firstname: Optional[str] = None
    lastname: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    facebook_user_name: Optional[str] = None
    image_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterCustomerQueryResponse:
    id: Optional[str] = None
    customer: Optional[NewsletterCustomerInfo] = 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 NewsletterCustomerQuery(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="Search for customer has done minimum number of bookings.")
    customer_min_bookings: Optional[int] = None
    """
    Search for customer has done minimum number of bookings.
    """


    # @ApiMember(Description="Search for customer has done maximum number of bookings.")
    customer_max_bookings: Optional[int] = None
    """
    Search for customer has done maximum number of bookings.
    """


    # @ApiMember(Description="Search for customer has booked any of the service in the list (List contain service id's).")
    booked_service_ids: Optional[List[int]] = None
    """
    Search for customer has booked any of the service in the list (List contain service id's).
    """


    # @ApiMember(Description="Search interval From datetime .")
    from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
    """
    Search interval From datetime .
    """


    # @ApiMember(Description="Search interval To datetime .")
    to: Optional[datetime.datetime] = None
    """
    Search interval To datetime .
    """


    # @ApiMember(Description="The max number of records you want to collect")
    max_records: Optional[int] = None
    """
    The max number of records you want to collect
    """


    # @ApiMember(Description="If you want to include the full customer information in the response")
    include_customer_information: bool = False
    """
    If you want to include the full customer information in the response
    """

Python NewsletterCustomerQuery 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 /newsletter/customers HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NewsletterCustomerQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Customer>
    <Email>String</Email>
    <FacebookUserName>String</FacebookUserName>
    <Firstname>String</Firstname>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <ImageUrl i:nil="true" />
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </Customer>
  <Id>00000000-0000-0000-0000-000000000000</Id>
</NewsletterCustomerQueryResponse>