| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Bookings:
[
{
Id: 0,
ServiceId: 0,
StatusId: 0,
UnbookedOn: "0001-01-01T00:00:00",
UnbookedComments: String,
BookedComments: String,
BookedBy: String,
Comments: String,
TextField1: String,
TextField2: String,
TextField3: String,
TextField4: String,
TextField5: String,
TextField6: String,
TextField7: String,
TextField8: String,
TextField9: String,
TextField10: String,
TextField11: String,
TextField12: String,
TextField13: String,
TextField14: String,
TextField15: String,
TextField16: String,
TextField17: String,
TextField18: String,
TextField19: String,
TextField20: String,
CommentsToCustomer: String
}
],
MessageLog:
[
{
Id: 0,
BookingId: 0,
Receiver: String,
Sender: String,
MessageTitle: String,
MessageBody: String,
CreatedBy: String,
Sent: False,
SentDate: "0001-01-01T00:00:00",
SendMethodId: 0
}
],
UserProfile:
{
Firstname: String,
Lastname: String,
Phone: String,
Email: String
},
Customer:
{
Firstname: String,
Lastname: String,
Phone: String,
Email: String,
Active: False,
FacebookUsername: String,
TextField1: String,
TextField2: String,
TextField3: String,
TextField4: String,
TextField5: String,
TextField6: String,
TextField7: String,
TextField8: String,
TextField9: String,
TextField10: String,
TextField11: String,
TextField12: String,
TextField13: String,
TextField14: String,
TextField15: String,
TextField16: String,
TextField17: String,
TextField18: String,
TextField19: String,
TextField20: String
},
CustomerComment:
[
{
Id: 0,
Comments: String
}
],
NewsletterLog:
[
{
Id: 0,
NewslettersId: 0,
Receiver: String,
Sender: String,
MessageTitle: String,
MessageBody: String,
Sent: False
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}