BokaMera.API.Host

<back to all web services

GDPRInactiveCustomerQuery

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/inactiveGet 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.

export class InactiveCustomerInfo
{
    public Id: string;
    public Firstname: string;
    public Lastname: string;
    public Email: string;
    public Phone: string;
    public FacebookUserName: string;
    public ImageUrl: string;

    public constructor(init?: Partial<InactiveCustomerInfo>) { (Object as any).assign(this, init); }
}

export class InactiveCustomerResponse
{
    public Id: string;
    public Customer: InactiveCustomerInfo;

    public constructor(init?: Partial<InactiveCustomerResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class GDPRInactiveCustomerQuery implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Inactive customers since the date. Inactive means they haven't done any bookings since that date. */
    // @ApiMember(Description="Inactive customers since the date. Inactive means they haven't done any bookings since that date.", IsRequired=true)
    public InactiveSince: string;

    /** @description If you want to include the full customer information in the response */
    // @ApiMember(Description="If you want to include the full customer information in the response")
    public IncludeCustomerInformation: boolean;

    public constructor(init?: Partial<GDPRInactiveCustomerQuery>) { (Object as any).assign(this, init); }
}

TypeScript GDPRInactiveCustomerQuery DTOs

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/inactive HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Customer":{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","FacebookUserName":"String"}}