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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type BookingStatusEnum =
        | Booked = 1
        | Unbooked = 2
        | Reserved = 3
        | Canceled = 4
        | AwaitingPayment = 5
        | AwaitingPaymentNoTimeLimit = 6
        | Payed = 7
        | AwaitingPaymentRequestFromAdmin = 8
        | AwaitingPaymentFromProvider = 9
        | Invoiced = 10

    [<AllowNullLiteral>]
    type DeleteOldReservationsResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        member val Id:Int32 = new Int32() with get,set
        member val From:DateTime = new DateTime() with get,set
        member val To:DateTime = new DateTime() with get,set
        member val Status:BookingStatusEnum = new BookingStatusEnum() with get,set
        member val StatusId:Int32 = new Int32() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val UpdatedDate:DateTime = new DateTime() with get,set

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type DeleteOldReservations() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The date to delete To. Only bookings that have ended by this date will be deleted.
        ///</summary>
        [<ApiMember(DataType="datetime", Description="The date to delete To. Only bookings that have ended by this date will be deleted.")>]
        member val To:DateTime = new DateTime() with get,set

        ///<summary>
        ///The system type of the code lock
        ///</summary>
        [<ApiMember(DataType="int", Description="The system type of the code lock", ParameterType="path")>]
        member val CodeLockSystemsId:Int32 = new Int32() with get,set

        ///<summary>
        ///If not logged in you can use token to update
        ///</summary>
        [<ApiMember(Description="If not logged in you can use token to update")>]
        member val Token:String = null with get,set

F# DeleteOldReservations DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<DeleteOldReservations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CodeLockSystemsId>0</CodeLockSystemsId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <To>0001-01-01T00:00:00</To>
  <Token>String</Token>
</DeleteOldReservations>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DeleteOldReservationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <From>0001-01-01T00:00:00</From>
  <Id>0</Id>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Status>Booked</Status>
  <StatusId>0</StatusId>
  <To>0001-01-01T00:00:00</To>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</DeleteOldReservationsResponse>