BokaMera.API.Host

<back to all web services

DeleteInactiveCustomers

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/gdpr/customers/inactiveDelete customers from your custom list.No bookings will be deleted, only changed to NoCustomSelected for the bookings that are connected to the customers to be deleted.
import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class DeleteInactiveCustomers implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * 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)
    DateTime? InactiveSince;

    DeleteInactiveCustomers({this.CompanyId,this.InactiveSince});
    DeleteInactiveCustomers.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        InactiveSince = JsonConverters.fromJson(json['InactiveSince'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'InactiveSince': JsonConverters.toJson(InactiveSince,'DateTime',context!)
    };

    getTypeName() => "DeleteInactiveCustomers";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'DeleteInactiveCustomers': TypeInfo(TypeOf.Class, create:() => DeleteInactiveCustomers()),
});

Dart DeleteInactiveCustomers 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.

DELETE /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

{}