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 |
---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Bookings | form | List<GDPRCustomerBookingsResponse> | No | List of all bookings associated with the customer |
MessageLog | form | List<GDPRCustomerMessageLogResponse> | No | List of all message logs associated with the customer |
UserProfile | form | UserProfileResponse | No | The user profile information for the customer |
Customer | form | GDPRCustomerInfoResponse | No | Detailed customer information |
CustomerComment | form | List<GDPRCustomerCommentsResponse> | No | List of all comments associated with the customer |
NewsletterLog | form | List<GDPRCustomerNewsletterLogResponse> | No | List of all newsletter logs associated with the customer |
ResponseStatus | form | ResponseStatus | No | Response status information |
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 | No | Comments added when the booking was cancelled |
BookedComments | form | string | No | Comments added when the booking was created |
BookedBy | form | string | No | The name of the person who made the booking |
Comments | form | string | No | General comments about the booking |
TextField1 | form | string | No | Custom text field 1 |
TextField2 | form | string | No | Custom text field 2 |
TextField3 | form | string | No | Custom text field 3 |
TextField4 | form | string | No | Custom text field 4 |
TextField5 | form | string | No | Custom text field 5 |
TextField6 | form | string | No | Custom text field 6 |
TextField7 | form | string | No | Custom text field 7 |
TextField8 | form | string | No | Custom text field 8 |
TextField9 | form | string | No | Custom text field 9 |
TextField10 | form | string | No | Custom text field 10 |
TextField11 | form | string | No | Custom text field 11 |
TextField12 | form | string | No | Custom text field 12 |
TextField13 | form | string | No | Custom text field 13 |
TextField14 | form | string | No | Custom text field 14 |
TextField15 | form | string | No | Custom text field 15 |
TextField16 | form | string | No | Custom text field 16 |
TextField17 | form | string | No | Custom text field 17 |
TextField18 | form | string | No | Custom text field 18 |
TextField19 | form | string | No | Custom text field 19 |
TextField20 | form | string | No | 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 | No | Comments sent to the customer about this booking |
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 | No | The recipient of the message |
Sender | form | string | No | The sender of the message |
MessageTitle | form | string | No | The title or subject of the message |
MessageBody | form | string | No | The body content of the message |
CreatedBy | form | string | No | 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) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Firstname | form | string | Yes | |
Lastname | form | string | Yes | |
Phone | form | string | Yes | |
form | string | Yes | ||
InvoiceAddress | form | InvoiceAddressResponse | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InvoiceAddressId | form | Guid | No | |
UserId | form | Guid? | No | |
CorporateIdentityNumber | form | string | No | |
InvoiceAddress1 | form | string | No | |
InvoiceAddress2 | form | string | No | |
InvoiceCity | form | string | No | |
InvoicePostalCode | form | string | No | |
InvoiceCountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | Guid | No | The unique identifier of the user |
Firstname | form | string | No | The user's first name |
Lastname | form | string | No | The user's last name |
Phone | form | string | No | The user's phone number |
form | string | No | The user's email address | |
Active | form | bool | No | Whether the user account is currently active |
FacebookUsername | form | string | No | The user's Facebook username |
TextField1 | form | string | No | Custom text field 1 |
TextField2 | form | string | No | Custom text field 2 |
TextField3 | form | string | No | Custom text field 3 |
TextField4 | form | string | No | Custom text field 4 |
TextField5 | form | string | No | Custom text field 5 |
TextField6 | form | string | No | Custom text field 6 |
TextField7 | form | string | No | Custom text field 7 |
TextField8 | form | string | No | Custom text field 8 |
TextField9 | form | string | No | Custom text field 9 |
TextField10 | form | string | No | Custom text field 10 |
TextField11 | form | string | No | Custom text field 11 |
TextField12 | form | string | No | Custom text field 12 |
TextField13 | form | string | No | Custom text field 13 |
TextField14 | form | string | No | Custom text field 14 |
TextField15 | form | string | No | Custom text field 15 |
TextField16 | form | string | No | Custom text field 16 |
TextField17 | form | string | No | Custom text field 17 |
TextField18 | form | string | No | Custom text field 18 |
TextField19 | form | string | No | Custom text field 19 |
TextField20 | form | string | No | 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 |
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 | No | 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 | No | URL to any image associated with the comment |
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 | No | The recipient of the newsletter |
Sender | form | string | No | The sender of the newsletter |
MessageTitle | form | string | No | The title or subject of the newsletter |
MessageBody | form | string | No | 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 .csv suffix or ?format=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"}}}