BokaMera.API.Host

GDPRCustomerQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/gdpr/customers/{CustomerId}	Get all customer information stored on the customer	Get all information stored on the customer

**GDPRCustomerQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	Yes	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
CustomerId	path	Guid	Yes	Id of the customer

**GDPRCustomerQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Bookings	form	List<GDPRCustomerBookingsResponse>	Yes	List of all bookings associated with the customer
MessageLog	form	List<GDPRCustomerMessageLogResponse>	Yes	List of all message logs associated with the customer
UserProfile	form	UserProfileResponse	Yes	The user profile information for the customer
Customer	form	GDPRCustomerInfoResponse	Yes	Detailed customer information
CustomerComment	form	List<GDPRCustomerCommentsResponse>	Yes	List of all comments associated with the customer
NewsletterLog	form	List<GDPRCustomerNewsletterLogResponse>	Yes	List of all newsletter logs associated with the customer
ResponseStatus	form	ResponseStatus	Yes	Response status information

**GDPRCustomerBookingsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company ID associated with this booking
Id	form	int	No	The unique identifier of the booking
CustomerId	form	Guid	No	The customer ID associated with this booking
ServiceId	form	int	No	The service ID for this booking
StatusId	form	int	No	The current status of the booking
From	form	DateTime	No	The start date and time of the booking
To	form	DateTime	No	The end date and time of the booking
UnbookedOn	form	DateTime?	No	The date when the booking was cancelled or unbooked
UnbookedComments	form	string	Yes	Comments added when the booking was cancelled
BookedComments	form	string	Yes	Comments added when the booking was created
BookedBy	form	string	Yes	The name of the person who made the booking
Comments	form	string	Yes	General comments about the booking
TextField1	form	string	Yes	Custom text field 1
TextField2	form	string	Yes	Custom text field 2
TextField3	form	string	Yes	Custom text field 3
TextField4	form	string	Yes	Custom text field 4
TextField5	form	string	Yes	Custom text field 5
TextField6	form	string	Yes	Custom text field 6
TextField7	form	string	Yes	Custom text field 7
TextField8	form	string	Yes	Custom text field 8
TextField9	form	string	Yes	Custom text field 9
TextField10	form	string	Yes	Custom text field 10
TextField11	form	string	Yes	Custom text field 11
TextField12	form	string	Yes	Custom text field 12
TextField13	form	string	Yes	Custom text field 13
TextField14	form	string	Yes	Custom text field 14
TextField15	form	string	Yes	Custom text field 15
TextField16	form	string	Yes	Custom text field 16
TextField17	form	string	Yes	Custom text field 17
TextField18	form	string	Yes	Custom text field 18
TextField19	form	string	Yes	Custom text field 19
TextField20	form	string	Yes	Custom text field 20
UpdatedDate	form	DateTime	No	The date when the booking was last updated
CreatedDate	form	DateTime	No	The date when the booking was created
CommentsToCustomer	form	string	Yes	Comments sent to the customer about this booking

**GDPRCustomerMessageLogResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company ID associated with this message
Id	form	int	No	The unique identifier of the message
BookingId	form	int?	No	The booking ID this message is related to, if any
Receiver	form	string	Yes	The recipient of the message
Sender	form	string	Yes	The sender of the message
MessageTitle	form	string	Yes	The title or subject of the message
MessageBody	form	string	Yes	The body content of the message
CreatedBy	form	string	Yes	The name of the person who created the message
Created	form	DateTime	No	The date when the message was created
Sent	form	bool	No	Whether the message was successfully sent
SentDate	form	DateTime?	No	The date when the message was sent
SendMethodId	form	int	No	The method used to send the message (e.g., email, SMS)

**UserProfileResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Phone	form	string	Yes
Email	form	string	Yes
InvoiceAddress	form	InvoiceAddressResponse	Yes

**InvoiceAddressResponse** Parameters:
Name	Parameter	Data Type	Required
InvoiceAddressId	form	Guid	No
UserId	form	Guid?	No
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**GDPRCustomerInfoResponse** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	Guid	No	The unique identifier of the user
Firstname	form	string	Yes	The user's first name
Lastname	form	string	Yes	The user's last name
Phone	form	string	Yes	The user's phone number
Email	form	string	Yes	The user's email address
Active	form	bool	No	Whether the user account is currently active
FacebookUsername	form	string	Yes	The user's Facebook username
TextField1	form	string	Yes	Custom text field 1
TextField2	form	string	Yes	Custom text field 2
TextField3	form	string	Yes	Custom text field 3
TextField4	form	string	Yes	Custom text field 4
TextField5	form	string	Yes	Custom text field 5
TextField6	form	string	Yes	Custom text field 6
TextField7	form	string	Yes	Custom text field 7
TextField8	form	string	Yes	Custom text field 8
TextField9	form	string	Yes	Custom text field 9
TextField10	form	string	Yes	Custom text field 10
TextField11	form	string	Yes	Custom text field 11
TextField12	form	string	Yes	Custom text field 12
TextField13	form	string	Yes	Custom text field 13
TextField14	form	string	Yes	Custom text field 14
TextField15	form	string	Yes	Custom text field 15
TextField16	form	string	Yes	Custom text field 16
TextField17	form	string	Yes	Custom text field 17
TextField18	form	string	Yes	Custom text field 18
TextField19	form	string	Yes	Custom text field 19
TextField20	form	string	Yes	Custom text field 20
Updated	form	DateTime	No	The date when the customer information was last updated
Created	form	DateTime	No	The date when the customer information was created

**GDPRCustomerCommentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company ID associated with this comment
Id	form	int	No	The unique identifier of the comment
CustomerId	form	Guid	No	The customer ID this comment is associated with
Comments	form	string	Yes	The content of the comment
Updated	form	DateTime	No	The date when the comment was last updated
Created	form	DateTime	No	The date when the comment was created
ImageUrl	form	Uri	Yes	URL to any image associated with the comment

**GDPRCustomerNewsletterLogResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company ID associated with this newsletter
Id	form	int	No	The unique identifier of the newsletter log entry
NewslettersId	form	int?	No	The newsletter ID this log entry is related to, if any
Receiver	form	string	Yes	The recipient of the newsletter
Sender	form	string	Yes	The sender of the newsletter
MessageTitle	form	string	Yes	The title or subject of the newsletter
MessageBody	form	string	Yes	The body content of the newsletter
Sent	form	bool	No	Whether the newsletter was successfully sent
Created	form	DateTime	No	The date when the newsletter was created

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 /gdpr/customers/{CustomerId} HTTP/1.1 
Host: api.bookmore.com 
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>
    <InvoiceAddress>
      <CorporateIdentityNumber>String</CorporateIdentityNumber>
      <InvoiceAddress1>String</InvoiceAddress1>
      <InvoiceAddress2>String</InvoiceAddress2>
      <InvoiceAddressId>00000000-0000-0000-0000-000000000000</InvoiceAddressId>
      <InvoiceCity>String</InvoiceCity>
      <InvoiceCountryCode>String</InvoiceCountryCode>
      <InvoicePostalCode>String</InvoicePostalCode>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
    </InvoiceAddress>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</GDPRCustomerQueryResponse>