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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class 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.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<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.")>
            Public Overridable Property To As Date

            '''<Summary>
            '''The system type of the code lock
            '''</Summary>
            <ApiMember(DataType:="int", Description:="The system type of the code lock", ParameterType:="path")>
            Public Overridable Property CodeLockSystemsId As Integer

            '''<Summary>
            '''If not logged in you can use token to update
            '''</Summary>
            <ApiMember(Description:="If not logged in you can use token to update")>
            Public Overridable Property Token As String
        End Class

        Public Partial Class DeleteOldReservationsResponse
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Id As Integer
            Public Overridable Property From As Date
            Public Overridable Property To As Date
            Public Overridable Property Status As BookingStatusEnum
            Public Overridable Property StatusId As Integer
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As Date
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum BookingStatusEnum
            Booked = 1
            Unbooked = 2
            Reserved = 3
            Canceled = 4
            AwaitingPayment = 5
            AwaitingPaymentNoTimeLimit = 6
            Payed = 7
            AwaitingPaymentRequestFromAdmin = 8
            AwaitingPaymentFromProvider = 9
            Invoiced = 10
        End Enum
    End Namespace
End Namespace

VB.NET 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>