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>NoList of all bookings associated with the customer
MessageLogformList<GDPRCustomerMessageLogResponse>NoList of all message logs associated with the customer
UserProfileformUserProfileResponseNoThe user profile information for the customer
CustomerformGDPRCustomerInfoResponseNoDetailed customer information
CustomerCommentformList<GDPRCustomerCommentsResponse>NoList of all comments associated with the customer
NewsletterLogformList<GDPRCustomerNewsletterLogResponse>NoList of all newsletter logs associated with the customer
ResponseStatusformResponseStatusNoResponse status information
GDPRCustomerBookingsResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company ID associated with this booking
IdformintNoThe unique identifier of the booking
CustomerIdformGuidNoThe customer ID associated with this booking
ServiceIdformintNoThe service ID for this booking
StatusIdformintNoThe current status of the booking
FromformDateTimeNoThe start date and time of the booking
ToformDateTimeNoThe end date and time of the booking
UnbookedOnformDateTime?NoThe date when the booking was cancelled or unbooked
UnbookedCommentsformstringNoComments added when the booking was cancelled
BookedCommentsformstringNoComments added when the booking was created
BookedByformstringNoThe name of the person who made the booking
CommentsformstringNoGeneral comments about the booking
TextField1formstringNoCustom text field 1
TextField2formstringNoCustom text field 2
TextField3formstringNoCustom text field 3
TextField4formstringNoCustom text field 4
TextField5formstringNoCustom text field 5
TextField6formstringNoCustom text field 6
TextField7formstringNoCustom text field 7
TextField8formstringNoCustom text field 8
TextField9formstringNoCustom text field 9
TextField10formstringNoCustom text field 10
TextField11formstringNoCustom text field 11
TextField12formstringNoCustom text field 12
TextField13formstringNoCustom text field 13
TextField14formstringNoCustom text field 14
TextField15formstringNoCustom text field 15
TextField16formstringNoCustom text field 16
TextField17formstringNoCustom text field 17
TextField18formstringNoCustom text field 18
TextField19formstringNoCustom text field 19
TextField20formstringNoCustom text field 20
UpdatedDateformDateTimeNoThe date when the booking was last updated
CreatedDateformDateTimeNoThe date when the booking was created
CommentsToCustomerformstringNoComments sent to the customer about this booking
GDPRCustomerMessageLogResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company ID associated with this message
IdformintNoThe unique identifier of the message
BookingIdformint?NoThe booking ID this message is related to, if any
ReceiverformstringNoThe recipient of the message
SenderformstringNoThe sender of the message
MessageTitleformstringNoThe title or subject of the message
MessageBodyformstringNoThe body content of the message
CreatedByformstringNoThe name of the person who created the message
CreatedformDateTimeNoThe date when the message was created
SentformboolNoWhether the message was successfully sent
SentDateformDateTime?NoThe date when the message was sent
SendMethodIdformintNoThe method used to send the message (e.g., email, SMS)
UserProfileResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringYes
LastnameformstringYes
PhoneformstringYes
EmailformstringYes
InvoiceAddressformInvoiceAddressResponseYes
InvoiceAddressResponse Parameters:
NameParameterData TypeRequiredDescription
InvoiceAddressIdformGuidNo
UserIdformGuid?No
CorporateIdentityNumberformstringNo
InvoiceAddress1formstringNo
InvoiceAddress2formstringNo
InvoiceCityformstringNo
InvoicePostalCodeformstringNo
InvoiceCountryCodeformstringNo
GDPRCustomerInfoResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNoThe unique identifier of the user
FirstnameformstringNoThe user's first name
LastnameformstringNoThe user's last name
PhoneformstringNoThe user's phone number
EmailformstringNoThe user's email address
ActiveformboolNoWhether the user account is currently active
FacebookUsernameformstringNoThe user's Facebook username
TextField1formstringNoCustom text field 1
TextField2formstringNoCustom text field 2
TextField3formstringNoCustom text field 3
TextField4formstringNoCustom text field 4
TextField5formstringNoCustom text field 5
TextField6formstringNoCustom text field 6
TextField7formstringNoCustom text field 7
TextField8formstringNoCustom text field 8
TextField9formstringNoCustom text field 9
TextField10formstringNoCustom text field 10
TextField11formstringNoCustom text field 11
TextField12formstringNoCustom text field 12
TextField13formstringNoCustom text field 13
TextField14formstringNoCustom text field 14
TextField15formstringNoCustom text field 15
TextField16formstringNoCustom text field 16
TextField17formstringNoCustom text field 17
TextField18formstringNoCustom text field 18
TextField19formstringNoCustom text field 19
TextField20formstringNoCustom text field 20
UpdatedformDateTimeNoThe date when the customer information was last updated
CreatedformDateTimeNoThe date when the customer information was created
GDPRCustomerCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company ID associated with this comment
IdformintNoThe unique identifier of the comment
CustomerIdformGuidNoThe customer ID this comment is associated with
CommentsformstringNoThe content of the comment
UpdatedformDateTimeNoThe date when the comment was last updated
CreatedformDateTimeNoThe date when the comment was created
ImageUrlformUriNoURL to any image associated with the comment
GDPRCustomerNewsletterLogResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company ID associated with this newsletter
IdformintNoThe unique identifier of the newsletter log entry
NewslettersIdformint?NoThe newsletter ID this log entry is related to, if any
ReceiverformstringNoThe recipient of the newsletter
SenderformstringNoThe sender of the newsletter
MessageTitleformstringNoThe title or subject of the newsletter
MessageBodyformstringNoThe body content of the newsletter
SentformboolNoWhether the newsletter was successfully sent
CreatedformDateTimeNoThe date when the newsletter was created

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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","InvoiceAddress":{"UserId":"00000000-0000-0000-0000-000000000000","CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"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"}}}