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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class DeleteOldReservations
    {
        /**
        * 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 UUID CompanyId = null;

        /**
        * The date to delete To. Only bookings that have ended by this date will be deleted.
        */
        @ApiMember(DataType="datetime", Description="The date to delete To. Only bookings that have ended by this date will be deleted.")
        public Date To = null;

        /**
        * The system type of the code lock
        */
        @ApiMember(DataType="int", Description="The system type of the code lock", ParameterType="path")
        public Integer CodeLockSystemsId = null;

        /**
        * If not logged in you can use token to update
        */
        @ApiMember(Description="If not logged in you can use token to update")
        public String Token = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteOldReservations setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Date getTo() { return To; }
        public DeleteOldReservations setTo(Date value) { this.To = value; return this; }
        public Integer getCodeLockSystemsId() { return CodeLockSystemsId; }
        public DeleteOldReservations setCodeLockSystemsId(Integer value) { this.CodeLockSystemsId = value; return this; }
        public String getToken() { return Token; }
        public DeleteOldReservations setToken(String value) { this.Token = value; return this; }
    }

    public static class DeleteOldReservationsResponse
    {
        public UUID CompanyId = null;
        public Integer Id = null;
        public Date From = null;
        public Date To = null;
        public BookingStatusEnum Status = null;
        public Integer StatusId = null;
        public ResponseStatus ResponseStatus = null;
        public Date CreatedDate = null;
        public Date UpdatedDate = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteOldReservationsResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public DeleteOldReservationsResponse setId(Integer value) { this.Id = value; return this; }
        public Date getFrom() { return From; }
        public DeleteOldReservationsResponse setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public DeleteOldReservationsResponse setTo(Date value) { this.To = value; return this; }
        public BookingStatusEnum getStatus() { return Status; }
        public DeleteOldReservationsResponse setStatus(BookingStatusEnum value) { this.Status = value; return this; }
        public Integer getStatusId() { return StatusId; }
        public DeleteOldReservationsResponse setStatusId(Integer value) { this.StatusId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DeleteOldReservationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public DeleteOldReservationsResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getUpdatedDate() { return UpdatedDate; }
        public DeleteOldReservationsResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
    }

    public static enum BookingStatusEnum
    {
        Booked(1),
        Unbooked(2),
        Reserved(3),
        Canceled(4),
        AwaitingPayment(5),
        AwaitingPaymentNoTimeLimit(6),
        Payed(7),
        AwaitingPaymentRequestFromAdmin(8),
        AwaitingPaymentFromProvider(9),
        Invoiced(10);

        private final int value;
        BookingStatusEnum(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java DeleteOldReservations 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.

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","CodeLockSystemsId":0,"Token":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}