| 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 |
|---|
"use strict";
export class GDPRCustomerBookingsResponse {
/** @param {{CompanyId?:string,Id?:number,CustomerId?:string,ServiceId?:number,StatusId?:number,From?:string,To?:string,UnbookedOn?:string,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,UpdatedDate?:string,CreatedDate?:string,CommentsToCustomer?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company ID associated with this booking */
CompanyId;
/**
* @type {number}
* @description The unique identifier of the booking */
Id;
/**
* @type {string}
* @description The customer ID associated with this booking */
CustomerId;
/**
* @type {number}
* @description The service ID for this booking */
ServiceId;
/**
* @type {number}
* @description The current status of the booking */
StatusId;
/**
* @type {string}
* @description The start date and time of the booking */
From;
/**
* @type {string}
* @description The end date and time of the booking */
To;
/**
* @type {?string}
* @description The date when the booking was cancelled or unbooked */
UnbookedOn;
/**
* @type {string}
* @description Comments added when the booking was cancelled */
UnbookedComments;
/**
* @type {string}
* @description Comments added when the booking was created */
BookedComments;
/**
* @type {string}
* @description The name of the person who made the booking */
BookedBy;
/**
* @type {string}
* @description General comments about the booking */
Comments;
/**
* @type {string}
* @description Custom text field 1 */
TextField1;
/**
* @type {string}
* @description Custom text field 2 */
TextField2;
/**
* @type {string}
* @description Custom text field 3 */
TextField3;
/**
* @type {string}
* @description Custom text field 4 */
TextField4;
/**
* @type {string}
* @description Custom text field 5 */
TextField5;
/**
* @type {string}
* @description Custom text field 6 */
TextField6;
/**
* @type {string}
* @description Custom text field 7 */
TextField7;
/**
* @type {string}
* @description Custom text field 8 */
TextField8;
/**
* @type {string}
* @description Custom text field 9 */
TextField9;
/**
* @type {string}
* @description Custom text field 10 */
TextField10;
/**
* @type {string}
* @description Custom text field 11 */
TextField11;
/**
* @type {string}
* @description Custom text field 12 */
TextField12;
/**
* @type {string}
* @description Custom text field 13 */
TextField13;
/**
* @type {string}
* @description Custom text field 14 */
TextField14;
/**
* @type {string}
* @description Custom text field 15 */
TextField15;
/**
* @type {string}
* @description Custom text field 16 */
TextField16;
/**
* @type {string}
* @description Custom text field 17 */
TextField17;
/**
* @type {string}
* @description Custom text field 18 */
TextField18;
/**
* @type {string}
* @description Custom text field 19 */
TextField19;
/**
* @type {string}
* @description Custom text field 20 */
TextField20;
/**
* @type {string}
* @description The date when the booking was last updated */
UpdatedDate;
/**
* @type {string}
* @description The date when the booking was created */
CreatedDate;
/**
* @type {string}
* @description Comments sent to the customer about this booking */
CommentsToCustomer;
}
export class GDPRCustomerMessageLogResponse {
/** @param {{CompanyId?:string,Id?:number,BookingId?:number,Receiver?:string,Sender?:string,MessageTitle?:string,MessageBody?:string,CreatedBy?:string,Created?:string,Sent?:boolean,SentDate?:string,SendMethodId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company ID associated with this message */
CompanyId;
/**
* @type {number}
* @description The unique identifier of the message */
Id;
/**
* @type {?number}
* @description The booking ID this message is related to, if any */
BookingId;
/**
* @type {string}
* @description The recipient of the message */
Receiver;
/**
* @type {string}
* @description The sender of the message */
Sender;
/**
* @type {string}
* @description The title or subject of the message */
MessageTitle;
/**
* @type {string}
* @description The body content of the message */
MessageBody;
/**
* @type {string}
* @description The name of the person who created the message */
CreatedBy;
/**
* @type {string}
* @description The date when the message was created */
Created;
/**
* @type {boolean}
* @description Whether the message was successfully sent */
Sent;
/**
* @type {?string}
* @description The date when the message was sent */
SentDate;
/**
* @type {number}
* @description The method used to send the message (e.g., email, SMS) */
SendMethodId;
}
export class InvoiceAddressResponse {
/** @param {{InvoiceAddressId?:string,UserId?:string,CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
InvoiceAddressId;
/** @type {?string} */
UserId;
/** @type {string} */
CorporateIdentityNumber;
/** @type {string} */
InvoiceAddress1;
/** @type {string} */
InvoiceAddress2;
/** @type {string} */
InvoiceCity;
/** @type {string} */
InvoicePostalCode;
/** @type {string} */
InvoiceCountryCode;
}
export class UserProfileResponse {
/** @param {{Id?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string,InvoiceAddress?:InvoiceAddressResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Firstname;
/** @type {string} */
Lastname;
/** @type {string} */
Phone;
/** @type {string} */
Email;
/** @type {InvoiceAddressResponse} */
InvoiceAddress;
}
export class GDPRCustomerInfoResponse {
/** @param {{UserId?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string,Active?:boolean,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,Updated?:string,Created?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique identifier of the user */
UserId;
/**
* @type {string}
* @description The user's first name */
Firstname;
/**
* @type {string}
* @description The user's last name */
Lastname;
/**
* @type {string}
* @description The user's phone number */
Phone;
/**
* @type {string}
* @description The user's email address */
Email;
/**
* @type {boolean}
* @description Whether the user account is currently active */
Active;
/**
* @type {string}
* @description The user's Facebook username */
FacebookUsername;
/**
* @type {string}
* @description Custom text field 1 */
TextField1;
/**
* @type {string}
* @description Custom text field 2 */
TextField2;
/**
* @type {string}
* @description Custom text field 3 */
TextField3;
/**
* @type {string}
* @description Custom text field 4 */
TextField4;
/**
* @type {string}
* @description Custom text field 5 */
TextField5;
/**
* @type {string}
* @description Custom text field 6 */
TextField6;
/**
* @type {string}
* @description Custom text field 7 */
TextField7;
/**
* @type {string}
* @description Custom text field 8 */
TextField8;
/**
* @type {string}
* @description Custom text field 9 */
TextField9;
/**
* @type {string}
* @description Custom text field 10 */
TextField10;
/**
* @type {string}
* @description Custom text field 11 */
TextField11;
/**
* @type {string}
* @description Custom text field 12 */
TextField12;
/**
* @type {string}
* @description Custom text field 13 */
TextField13;
/**
* @type {string}
* @description Custom text field 14 */
TextField14;
/**
* @type {string}
* @description Custom text field 15 */
TextField15;
/**
* @type {string}
* @description Custom text field 16 */
TextField16;
/**
* @type {string}
* @description Custom text field 17 */
TextField17;
/**
* @type {string}
* @description Custom text field 18 */
TextField18;
/**
* @type {string}
* @description Custom text field 19 */
TextField19;
/**
* @type {string}
* @description Custom text field 20 */
TextField20;
/**
* @type {string}
* @description The date when the customer information was last updated */
Updated;
/**
* @type {string}
* @description The date when the customer information was created */
Created;
}
export class GDPRCustomerCommentsResponse {
/** @param {{CompanyId?:string,Id?:number,CustomerId?:string,Comments?:string,Updated?:string,Created?:string,ImageUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company ID associated with this comment */
CompanyId;
/**
* @type {number}
* @description The unique identifier of the comment */
Id;
/**
* @type {string}
* @description The customer ID this comment is associated with */
CustomerId;
/**
* @type {string}
* @description The content of the comment */
Comments;
/**
* @type {string}
* @description The date when the comment was last updated */
Updated;
/**
* @type {string}
* @description The date when the comment was created */
Created;
/**
* @type {string}
* @description URL to any image associated with the comment */
ImageUrl;
}
export class GDPRCustomerNewsletterLogResponse {
/** @param {{CompanyId?:string,Id?:number,NewslettersId?:number,Receiver?:string,Sender?:string,MessageTitle?:string,MessageBody?:string,Sent?:boolean,Created?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company ID associated with this newsletter */
CompanyId;
/**
* @type {number}
* @description The unique identifier of the newsletter log entry */
Id;
/**
* @type {?number}
* @description The newsletter ID this log entry is related to, if any */
NewslettersId;
/**
* @type {string}
* @description The recipient of the newsletter */
Receiver;
/**
* @type {string}
* @description The sender of the newsletter */
Sender;
/**
* @type {string}
* @description The title or subject of the newsletter */
MessageTitle;
/**
* @type {string}
* @description The body content of the newsletter */
MessageBody;
/**
* @type {boolean}
* @description Whether the newsletter was successfully sent */
Sent;
/**
* @type {string}
* @description The date when the newsletter was created */
Created;
}
export class GDPRCustomerQueryResponse {
/** @param {{Bookings?:GDPRCustomerBookingsResponse[],MessageLog?:GDPRCustomerMessageLogResponse[],UserProfile?:UserProfileResponse,Customer?:GDPRCustomerInfoResponse,CustomerComment?:GDPRCustomerCommentsResponse[],NewsletterLog?:GDPRCustomerNewsletterLogResponse[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GDPRCustomerBookingsResponse[]}
* @description List of all bookings associated with the customer */
Bookings;
/**
* @type {GDPRCustomerMessageLogResponse[]}
* @description List of all message logs associated with the customer */
MessageLog;
/**
* @type {UserProfileResponse}
* @description The user profile information for the customer */
UserProfile;
/**
* @type {GDPRCustomerInfoResponse}
* @description Detailed customer information */
Customer;
/**
* @type {GDPRCustomerCommentsResponse[]}
* @description List of all comments associated with the customer */
CustomerComment;
/**
* @type {GDPRCustomerNewsletterLogResponse[]}
* @description List of all newsletter logs associated with the customer */
NewsletterLog;
/**
* @type {ResponseStatus}
* @description Response status information */
ResponseStatus;
}
export class GDPRCustomerQuery {
/** @param {{CompanyId?:string,CustomerId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description 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 */
CompanyId;
/**
* @type {string}
* @description Id of the customer */
CustomerId;
}
JavaScript GDPRCustomerQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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.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>
<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>