| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /gdpr/customers/inactive | Get all customers that have been inactive due to the filtering. | Get all customers that have been inactive due to the filtering you add in the request. |
|---|
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 InactiveCustomerInfo:
# @ApiMember(Description="The unique identifier of the customer")
id: Optional[str] = None
"""
The unique identifier of the customer
"""
# @ApiMember(Description="The customer's first name")
firstname: Optional[str] = None
"""
The customer's first name
"""
# @ApiMember(Description="The customer's last name")
lastname: Optional[str] = None
"""
The customer's last name
"""
# @ApiMember(Description="The customer's email address")
email: Optional[str] = None
"""
The customer's email address
"""
# @ApiMember(Description="The customer's phone number")
phone: Optional[str] = None
"""
The customer's phone number
"""
# @ApiMember(Description="The customer's Facebook username")
facebook_user_name: Optional[str] = None
"""
The customer's Facebook username
"""
# @ApiMember(Description="URL to the customer's profile image")
image_url: Optional[str] = None
"""
URL to the customer's profile image
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InactiveCustomerResponse:
id: Optional[str] = None
customer: Optional[InactiveCustomerInfo] = 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 GDPRInactiveCustomerQuery(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="Inactive customers since the date. Inactive means they haven't done any bookings since that date.", IsRequired=true)
inactive_since: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Inactive customers since the date. Inactive means they haven't done any bookings since that date.
"""
# @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 GDPRInactiveCustomerQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /gdpr/customers/inactive HTTP/1.1 Host: api.bookmore.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Customer":{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","FacebookUserName":"String"}}