BokaMera.API.Host

<back to all web services

CreateBookingLogItem

The following routes are available for this service:
POST/bookinglogAdd a new event to booking logAdd a new event to the booking of the company of the currently logged in user, only administrators are allowed to add items to event log.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
public class CreateBookingLogItem : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * The booking id
    */
    // @ApiMember(Description="The booking id", IsRequired=true)
    public var bookingId:Int

    /**
    * The type of event
    */
    // @ApiMember(Description="The type of event", IsRequired=true)
    public var eventTypeId:Int

    /**
    * Comments that could be added to the event log item
    */
    // @ApiMember(Description="Comments that could be added to the event log item", IsRequired=true)
    public var comments:String

    /**
    * Then date when the event occured, leave blank if current datetime
    */
    // @ApiMember(Description="Then date when the event occured, leave blank if current datetime", IsRequired=true)
    public var created:Date?

    required public init(){}
}

public class BookingLogQueryResponse : Codable
{
    /**
    * The booking log id
    */
    // @ApiMember(Description="The booking log id")
    public var id:Int

    /**
    * The booking id
    */
    // @ApiMember(Description="The booking id")
    public var bookingId:Int

    /**
    * The type of event
    */
    // @ApiMember(Description="The type of event")
    public var eventTypeId:Int

    /**
    * The type of event
    */
    // @ApiMember(Description="The type of event")
    public var eventType:BookingLogEventTypeResponse

    /**
    * Comments that could be added to the event log item
    */
    // @ApiMember(Description="Comments that could be added to the event log item")
    public var comments:String

    /**
    * The user created the event
    */
    // @ApiMember(Description="The user created the event")
    public var userName:String

    /**
    * Then date when the event occured
    */
    // @ApiMember(Description="Then date when the event occured")
    public var created:Date

    required public init(){}
}

public class BookingLogEventTypeResponse : Codable
{
    /**
    * The event type id
    */
    // @ApiMember(Description="The event type id")
    public var id:Int

    /**
    * The event type name
    */
    // @ApiMember(Description="The event type name")
    public var name:String

    /**
    * The event type description
    */
    // @ApiMember(Description="The event type description")
    public var Description:String

    required public init(){}
}


Swift CreateBookingLogItem 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 /bookinglog HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","BookingId":0,"EventTypeId":0,"Comments":"String","Created":"0001-01-01T00:00:00"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"BookingId":0,"EventTypeId":0,"EventType":{"Id":0,"Name":"String","Description":"String"},"Comments":"String","UserName":"String"}