BokaMera.API.Host

<back to all web services

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 customerGet all information stored on the customer
GDPRCustomerQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesEnter 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
CustomerIdpathGuidYesId of the customer
GDPRCustomerQueryResponse Parameters:
NameParameterData TypeRequiredDescription
BookingsformList<GDPRCustomerBookingsResponse>No
MessageLogformList<GDPRCustomerMessageLogResponse>No
UserProfileformUserProfileResponseNo
CustomerformGDPRCustomerInfoResponseNo
CustomerCommentformList<GDPRCustomerCommentsResponse>No
NewsletterLogformList<GDPRCustomerNewsletterLogResponse>No
ResponseStatusformResponseStatusNo
GDPRCustomerBookingsResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
CustomerIdformGuidNo
ServiceIdformintNo
StatusIdformintNo
FromformDateTimeNo
ToformDateTimeNo
UnbookedOnformDateTime?No
UnbookedCommentsformstringNo
BookedCommentsformstringNo
BookedByformstringNo
CommentsformstringNo
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
UpdatedDateformDateTimeNo
CreatedDateformDateTimeNo
CommentsToCustomerformstringNo
GDPRCustomerMessageLogResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
BookingIdformint?No
ReceiverformstringNo
SenderformstringNo
MessageTitleformstringNo
MessageBodyformstringNo
CreatedByformstringNo
CreatedformDateTimeNo
SentformboolNo
SentDateformDateTime?No
SendMethodIdformintNo
UserProfileResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
PhoneformstringNo
EmailformstringNo
GDPRCustomerInfoResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
FirstnameformstringNo
LastnameformstringNo
PhoneformstringNo
EmailformstringNo
ActiveformboolNo
FacebookUsernameformstringNo
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
UpdatedformDateTimeNo
CreatedformDateTimeNo
GDPRCustomerCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
CustomerIdformGuidNo
CommentsformstringNo
UpdatedformDateTimeNo
CreatedformDateTimeNo
ImageUrlformUriNo
GDPRCustomerNewsletterLogResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
NewslettersIdformint?No
ReceiverformstringNo
SenderformstringNo
MessageTitleformstringNo
MessageBodyformstringNo
SentformboolNo
CreatedformDateTimeNo

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: testapi.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>