BokaMera.API.Host

<back to all web services

BookingLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/bookinglogFind booking log for booking.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    // @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class BookingLogQuery extends QueryDb<BookingLog, BookingLogQueryResponse>
    {
        /**
        * Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used
        */
        @ApiMember(Description="Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used", IsRequired=true, ParameterType="query")
        public UUID CompanyId = null;

        /**
        * Enter the booking id you want to get the log
        */
        @ApiMember(Description="Enter the booking id you want to get the log", IsRequired=true, ParameterType="query")
        public Integer BookingId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public BookingLogQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public BookingLogQuery setBookingId(Integer value) { this.BookingId = value; return this; }
    }

    public static class QueryDb<From, Into> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        /**
        * Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
        */
        @DataMember(Order=1)
        public Integer Skip = null;

        /**
        * Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
        */
        @DataMember(Order=2)
        public Integer Take = null;

        /**
        * Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
        */
        @DataMember(Order=3)
        public String OrderBy = null;

        /**
        * Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
        */
        @DataMember(Order=4)
        public String OrderByDesc = null;

        /**
        * Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
        */
        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class BookingLog extends BaseModel
    {
        @References(BookingLogEventType.class)
        public Integer EventTypeId = null;

        public BookingLogEventType EventType = null;
        @Required()
        public UUID CompanyId = null;

        @Required()
        public Integer BookingId = null;

        public Integer Id = null;
        public String Comments = null;
        public String UserId = null;
        @Required()
        public Date Created = null;

        public Date ModifiedDate = null;
        
        public Integer getEventTypeId() { return EventTypeId; }
        public BookingLog setEventTypeId(Integer value) { this.EventTypeId = value; return this; }
        public BookingLogEventType getEventType() { return EventType; }
        public BookingLog setEventType(BookingLogEventType value) { this.EventType = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public BookingLog setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public BookingLog setBookingId(Integer value) { this.BookingId = value; return this; }
        public Integer getId() { return Id; }
        public BookingLog setId(Integer value) { this.Id = value; return this; }
        public String getComments() { return Comments; }
        public BookingLog setComments(String value) { this.Comments = value; return this; }
        public String getUserId() { return UserId; }
        public BookingLog setUserId(String value) { this.UserId = value; return this; }
        public Date getCreated() { return Created; }
        public BookingLog setCreated(Date value) { this.Created = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public BookingLog setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class BookingLogEventType extends BaseModel
    {
        @Required()
        public String Name = null;

        @Required()
        public String Description = null;

        public Date ModifiedDate = null;
        @Required()
        public Integer Id = null;
        
        public String getName() { return Name; }
        public BookingLogEventType setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public BookingLogEventType setDescription(String value) { this.Description = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public BookingLogEventType setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public Integer getId() { return Id; }
        public BookingLogEventType setId(Integer value) { this.Id = value; return this; }
    }

    public static class BookingLogQueryResponse
    {
        /**
        * The booking log id
        */
        @ApiMember(Description="The booking log id")
        public Integer Id = null;

        /**
        * The booking id
        */
        @ApiMember(Description="The booking id")
        public Integer BookingId = null;

        /**
        * The type of event
        */
        @ApiMember(Description="The type of event")
        public Integer EventTypeId = null;

        /**
        * The type of event
        */
        @ApiMember(Description="The type of event")
        public BookingLogEventTypeResponse EventType = null;

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

        /**
        * The user created the event
        */
        @ApiMember(Description="The user created the event")
        public String UserName = null;

        /**
        * Then date when the event occured
        */
        @ApiMember(Description="Then date when the event occured")
        public Date Created = null;
        
        public Integer getId() { return Id; }
        public BookingLogQueryResponse setId(Integer value) { this.Id = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public BookingLogQueryResponse setBookingId(Integer value) { this.BookingId = value; return this; }
        public Integer getEventTypeId() { return EventTypeId; }
        public BookingLogQueryResponse setEventTypeId(Integer value) { this.EventTypeId = value; return this; }
        public BookingLogEventTypeResponse getEventType() { return EventType; }
        public BookingLogQueryResponse setEventType(BookingLogEventTypeResponse value) { this.EventType = value; return this; }
        public String getComments() { return Comments; }
        public BookingLogQueryResponse setComments(String value) { this.Comments = value; return this; }
        public String getUserName() { return UserName; }
        public BookingLogQueryResponse setUserName(String value) { this.UserName = value; return this; }
        public Date getCreated() { return Created; }
        public BookingLogQueryResponse setCreated(Date value) { this.Created = value; return this; }
    }

    public static class BookingLogEventTypeResponse
    {
        /**
        * The event type id
        */
        @ApiMember(Description="The event type id")
        public Integer Id = null;

        /**
        * The event type name
        */
        @ApiMember(Description="The event type name")
        public String Name = null;

        /**
        * The event type description
        */
        @ApiMember(Description="The event type description")
        public String Description = null;
        
        public Integer getId() { return Id; }
        public BookingLogEventTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public BookingLogEventTypeResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public BookingLogEventTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

    @DataContract
    public static class QueryResponse<AccessKeyTypeResponse>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<AccessKeyTypeResponse> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
        public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AccessKeyTypeResponse
    {
        public Integer Id = null;
        public String KeyType = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getKeyType() { return KeyType; }
        public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
        public String getDescription() { return Description; }
        public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

}

Java BookingLogQuery DTOs

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

HTTP + OTHER

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

GET /bookinglog HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"BookingId":0,"EventTypeId":0,"EventType":{"Id":0,"Name":"String","Description":"String"},"Comments":"String","UserName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}