BokaMera.API.Host

<back to all web services

DeleteOldReservations

Requires Authentication
The following routes are available for this service:
POST/codelock/{CodeLockSystemsId}/reservations/Will delete all reservation that is in the past for each company having schedule delete setting turned on.Will delete all reservation that is in the past for each company having schedule delete setting turned on.
"use strict";
/** @typedef {number} */
export var BookingStatusEnum;
(function (BookingStatusEnum) {
    BookingStatusEnum[BookingStatusEnum["Booked"] = 1] = "Booked"
    BookingStatusEnum[BookingStatusEnum["Unbooked"] = 2] = "Unbooked"
    BookingStatusEnum[BookingStatusEnum["Reserved"] = 3] = "Reserved"
    BookingStatusEnum[BookingStatusEnum["Canceled"] = 4] = "Canceled"
    BookingStatusEnum[BookingStatusEnum["AwaitingPayment"] = 5] = "AwaitingPayment"
    BookingStatusEnum[BookingStatusEnum["AwaitingPaymentNoTimeLimit"] = 6] = "AwaitingPaymentNoTimeLimit"
    BookingStatusEnum[BookingStatusEnum["Payed"] = 7] = "Payed"
    BookingStatusEnum[BookingStatusEnum["AwaitingPaymentRequestFromAdmin"] = 8] = "AwaitingPaymentRequestFromAdmin"
    BookingStatusEnum[BookingStatusEnum["AwaitingPaymentFromProvider"] = 9] = "AwaitingPaymentFromProvider"
    BookingStatusEnum[BookingStatusEnum["Invoiced"] = 10] = "Invoiced"
})(BookingStatusEnum || (BookingStatusEnum = {}));
export class DeleteOldReservationsResponse {
    /** @param {{CompanyId?:string,Id?:number,From?:string,To?:string,Status?:BookingStatusEnum,StatusId?:number,ResponseStatus?:ResponseStatus,CreatedDate?:string,UpdatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {string} */
    From;
    /** @type {string} */
    To;
    /** @type {BookingStatusEnum} */
    Status;
    /** @type {number} */
    StatusId;
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    UpdatedDate;
}
export class DeleteOldReservations {
    /** @param {{CompanyId?:string,To?:string,CodeLockSystemsId?:number,Token?:string}} [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 The date to delete To. Only bookings that have ended by this date will be deleted. */
    To;
    /**
     * @type {number}
     * @description The system type of the code lock */
    CodeLockSystemsId;
    /**
     * @type {string}
     * @description If not logged in you can use token to update */
    Token;
}

JavaScript DeleteOldReservations DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /codelock/{CodeLockSystemsId}/reservations/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","CodeLockSystemsId":0,"Token":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Status":"Booked","StatusId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}