Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /gdpr/customers/{CustomerId} | Get all customer information stored on the customer | Get all information stored on the customer |
---|
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 GDPRCustomerBookingsResponse:
company_id: Optional[str] = None
id: int = 0
customer_id: Optional[str] = None
service_id: int = 0
status_id: int = 0
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
to: datetime.datetime = datetime.datetime(1, 1, 1)
unbooked_on: Optional[datetime.datetime] = None
unbooked_comments: Optional[str] = None
booked_comments: Optional[str] = None
booked_by: Optional[str] = None
comments: Optional[str] = None
text_field1: Optional[str] = None
text_field2: Optional[str] = None
text_field3: Optional[str] = None
text_field4: Optional[str] = None
text_field5: Optional[str] = None
text_field6: Optional[str] = None
text_field7: Optional[str] = None
text_field8: Optional[str] = None
text_field9: Optional[str] = None
text_field10: Optional[str] = None
text_field11: Optional[str] = None
text_field12: Optional[str] = None
text_field13: Optional[str] = None
text_field14: Optional[str] = None
text_field15: Optional[str] = None
text_field16: Optional[str] = None
text_field17: Optional[str] = None
text_field18: Optional[str] = None
text_field19: Optional[str] = None
text_field20: Optional[str] = None
updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
comments_to_customer: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GDPRCustomerMessageLogResponse:
company_id: Optional[str] = None
id: int = 0
booking_id: Optional[int] = None
receiver: Optional[str] = None
sender: Optional[str] = None
message_title: Optional[str] = None
message_body: Optional[str] = None
created_by: Optional[str] = None
created: datetime.datetime = datetime.datetime(1, 1, 1)
sent: bool = False
sent_date: Optional[datetime.datetime] = None
send_method_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfileResponse:
id: Optional[str] = None
firstname: Optional[str] = None
lastname: Optional[str] = None
phone: Optional[str] = None
email: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GDPRCustomerInfoResponse:
user_id: Optional[str] = None
firstname: Optional[str] = None
lastname: Optional[str] = None
phone: Optional[str] = None
email: Optional[str] = None
active: bool = False
facebook_username: Optional[str] = None
text_field1: Optional[str] = None
text_field2: Optional[str] = None
text_field3: Optional[str] = None
text_field4: Optional[str] = None
text_field5: Optional[str] = None
text_field6: Optional[str] = None
text_field7: Optional[str] = None
text_field8: Optional[str] = None
text_field9: Optional[str] = None
text_field10: Optional[str] = None
text_field11: Optional[str] = None
text_field12: Optional[str] = None
text_field13: Optional[str] = None
text_field14: Optional[str] = None
text_field15: Optional[str] = None
text_field16: Optional[str] = None
text_field17: Optional[str] = None
text_field18: Optional[str] = None
text_field19: Optional[str] = None
text_field20: Optional[str] = None
updated: datetime.datetime = datetime.datetime(1, 1, 1)
created: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GDPRCustomerCommentsResponse:
company_id: Optional[str] = None
id: int = 0
customer_id: Optional[str] = None
comments: Optional[str] = None
updated: datetime.datetime = datetime.datetime(1, 1, 1)
created: datetime.datetime = datetime.datetime(1, 1, 1)
image_url: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GDPRCustomerNewsletterLogResponse:
company_id: Optional[str] = None
id: int = 0
newsletters_id: Optional[int] = None
receiver: Optional[str] = None
sender: Optional[str] = None
message_title: Optional[str] = None
message_body: Optional[str] = None
sent: bool = False
created: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GDPRCustomerQueryResponse:
bookings: Optional[List[GDPRCustomerBookingsResponse]] = None
message_log: Optional[List[GDPRCustomerMessageLogResponse]] = None
user_profile: Optional[UserProfileResponse] = None
customer: Optional[GDPRCustomerInfoResponse] = None
customer_comment: Optional[List[GDPRCustomerCommentsResponse]] = None
newsletter_log: Optional[List[GDPRCustomerNewsletterLogResponse]] = None
response_status: Optional[ResponseStatus] = None
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GDPRCustomerQuery(ICompany):
# @ApiMember(Description="Enter the company and id you want to see the information for a resource, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown ", IsRequired=true, ParameterType="query")
company_id: Optional[str] = None
"""
Enter the company and id you want to see the information for a resource, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown
"""
# @ApiMember(Description="Id of the customer", IsRequired=true, ParameterType="path")
customer_id: Optional[str] = None
"""
Id of the customer
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /gdpr/customers/{CustomerId} HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GDPRCustomerQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Bookings> <GDPRCustomerBookingsResponse> <BookedBy>String</BookedBy> <BookedComments>String</BookedComments> <Comments>String</Comments> <CommentsToCustomer>String</CommentsToCustomer> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <From>0001-01-01T00:00:00</From> <Id>0</Id> <ServiceId>0</ServiceId> <StatusId>0</StatusId> <TextField1>String</TextField1> <TextField10>String</TextField10> <TextField11>String</TextField11> <TextField12>String</TextField12> <TextField13>String</TextField13> <TextField14>String</TextField14> <TextField15>String</TextField15> <TextField16>String</TextField16> <TextField17>String</TextField17> <TextField18>String</TextField18> <TextField19>String</TextField19> <TextField2>String</TextField2> <TextField20>String</TextField20> <TextField3>String</TextField3> <TextField4>String</TextField4> <TextField5>String</TextField5> <TextField6>String</TextField6> <TextField7>String</TextField7> <TextField8>String</TextField8> <TextField9>String</TextField9> <To>0001-01-01T00:00:00</To> <UnbookedComments>String</UnbookedComments> <UnbookedOn>0001-01-01T00:00:00</UnbookedOn> <UpdatedDate>0001-01-01T00:00:00</UpdatedDate> </GDPRCustomerBookingsResponse> </Bookings> <Customer> <Active>false</Active> <Created>0001-01-01T00:00:00</Created> <Email>String</Email> <FacebookUsername>String</FacebookUsername> <Firstname>String</Firstname> <Lastname>String</Lastname> <Phone>String</Phone> <TextField1>String</TextField1> <TextField10>String</TextField10> <TextField11>String</TextField11> <TextField12>String</TextField12> <TextField13>String</TextField13> <TextField14>String</TextField14> <TextField15>String</TextField15> <TextField16>String</TextField16> <TextField17>String</TextField17> <TextField18>String</TextField18> <TextField19>String</TextField19> <TextField2>String</TextField2> <TextField20>String</TextField20> <TextField3>String</TextField3> <TextField4>String</TextField4> <TextField5>String</TextField5> <TextField6>String</TextField6> <TextField7>String</TextField7> <TextField8>String</TextField8> <TextField9>String</TextField9> <Updated>0001-01-01T00:00:00</Updated> <UserId>00000000-0000-0000-0000-000000000000</UserId> </Customer> <CustomerComment> <GDPRCustomerCommentsResponse> <Comments>String</Comments> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <Id>0</Id> <ImageUrl i:nil="true" /> <Updated>0001-01-01T00:00:00</Updated> </GDPRCustomerCommentsResponse> </CustomerComment> <MessageLog> <GDPRCustomerMessageLogResponse> <BookingId>0</BookingId> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <CreatedBy>String</CreatedBy> <Id>0</Id> <MessageBody>String</MessageBody> <MessageTitle>String</MessageTitle> <Receiver>String</Receiver> <SendMethodId>0</SendMethodId> <Sender>String</Sender> <Sent>false</Sent> <SentDate>0001-01-01T00:00:00</SentDate> </GDPRCustomerMessageLogResponse> </MessageLog> <NewsletterLog> <GDPRCustomerNewsletterLogResponse> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <Id>0</Id> <MessageBody>String</MessageBody> <MessageTitle>String</MessageTitle> <NewslettersId>0</NewslettersId> <Receiver>String</Receiver> <Sender>String</Sender> <Sent>false</Sent> </GDPRCustomerNewsletterLogResponse> </NewsletterLog> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <UserProfile> <Email>String</Email> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <Lastname>String</Lastname> <Phone>String</Phone> </UserProfile> </GDPRCustomerQueryResponse>