| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /gdpr/customers/inactive | Get all customers that have been inactive due to the filtering. | Get all customers that have been inactive due to the filtering you add in the request. |
|---|
"use strict";
export class InactiveCustomerInfo {
/** @param {{Id?:string,Firstname?:string,Lastname?:string,Email?:string,Phone?:string,FacebookUserName?:string,ImageUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Firstname;
/** @type {string} */
Lastname;
/** @type {string} */
Email;
/** @type {string} */
Phone;
/** @type {string} */
FacebookUserName;
/** @type {string} */
ImageUrl;
}
export class InactiveCustomerResponse {
/** @param {{Id?:string,Customer?:InactiveCustomerInfo}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {InactiveCustomerInfo} */
Customer;
}
export class GDPRInactiveCustomerQuery {
/** @param {{CompanyId?:string,InactiveSince?:string,IncludeCustomerInformation?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {string}
* @description Inactive customers since the date. Inactive means they haven't done any bookings since that date. */
InactiveSince;
/**
* @type {boolean}
* @description If you want to include the full customer information in the response */
IncludeCustomerInformation;
}
JavaScript GDPRInactiveCustomerQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /gdpr/customers/inactive HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Customer:
{
Firstname: String,
Lastname: String,
Email: String,
Phone: String,
FacebookUserName: String
}
}