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>YesList of all bookings associated with the customer
MessageLogformList<GDPRCustomerMessageLogResponse>YesList of all message logs associated with the customer
UserProfileformUserProfileResponseYesThe user profile information for the customer
CustomerformGDPRCustomerInfoResponseYesDetailed customer information
CustomerCommentformList<GDPRCustomerCommentsResponse>YesList of all comments associated with the customer
NewsletterLogformList<GDPRCustomerNewsletterLogResponse>YesList of all newsletter logs associated with the customer
ResponseStatusformResponseStatusYesResponse 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
UnbookedCommentsformstringYesComments added when the booking was cancelled
BookedCommentsformstringYesComments added when the booking was created
BookedByformstringYesThe name of the person who made the booking
CommentsformstringYesGeneral comments about the booking
TextField1formstringYesCustom text field 1
TextField2formstringYesCustom text field 2
TextField3formstringYesCustom text field 3
TextField4formstringYesCustom text field 4
TextField5formstringYesCustom text field 5
TextField6formstringYesCustom text field 6
TextField7formstringYesCustom text field 7
TextField8formstringYesCustom text field 8
TextField9formstringYesCustom text field 9
TextField10formstringYesCustom text field 10
TextField11formstringYesCustom text field 11
TextField12formstringYesCustom text field 12
TextField13formstringYesCustom text field 13
TextField14formstringYesCustom text field 14
TextField15formstringYesCustom text field 15
TextField16formstringYesCustom text field 16
TextField17formstringYesCustom text field 17
TextField18formstringYesCustom text field 18
TextField19formstringYesCustom text field 19
TextField20formstringYesCustom text field 20
UpdatedDateformDateTimeNoThe date when the booking was last updated
CreatedDateformDateTimeNoThe date when the booking was created
CommentsToCustomerformstringYesComments 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
ReceiverformstringYesThe recipient of the message
SenderformstringYesThe sender of the message
MessageTitleformstringYesThe title or subject of the message
MessageBodyformstringYesThe body content of the message
CreatedByformstringYesThe 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
CorporateIdentityNumberformstringYes
InvoiceAddress1formstringYes
InvoiceAddress2formstringYes
InvoiceCityformstringYes
InvoicePostalCodeformstringYes
InvoiceCountryCodeformstringYes
GDPRCustomerInfoResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNoThe unique identifier of the user
FirstnameformstringYesThe user's first name
LastnameformstringYesThe user's last name
PhoneformstringYesThe user's phone number
EmailformstringYesThe user's email address
ActiveformboolNoWhether the user account is currently active
FacebookUsernameformstringYesThe user's Facebook username
TextField1formstringYesCustom text field 1
TextField2formstringYesCustom text field 2
TextField3formstringYesCustom text field 3
TextField4formstringYesCustom text field 4
TextField5formstringYesCustom text field 5
TextField6formstringYesCustom text field 6
TextField7formstringYesCustom text field 7
TextField8formstringYesCustom text field 8
TextField9formstringYesCustom text field 9
TextField10formstringYesCustom text field 10
TextField11formstringYesCustom text field 11
TextField12formstringYesCustom text field 12
TextField13formstringYesCustom text field 13
TextField14formstringYesCustom text field 14
TextField15formstringYesCustom text field 15
TextField16formstringYesCustom text field 16
TextField17formstringYesCustom text field 17
TextField18formstringYesCustom text field 18
TextField19formstringYesCustom text field 19
TextField20formstringYesCustom 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
CommentsformstringYesThe content of the comment
UpdatedformDateTimeNoThe date when the comment was last updated
CreatedformDateTimeNoThe date when the comment was created
ImageUrlformUriYesURL 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
ReceiverformstringYesThe recipient of the newsletter
SenderformstringYesThe sender of the newsletter
MessageTitleformstringYesThe title or subject of the newsletter
MessageBodyformstringYesThe 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"}}}