BokaMera.API.Host

ReportQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/bookings/reports/	Get all reports	Get a list of all existing reports.

import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class ReportQuery : QueryDb2<BookingPrintout, ReportQueryResponse>, ICompany
{
    /**
    * 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?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case companyId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
    }
}

public class BookingPrintout : PrintoutBase
{
    public var messageTemplate:String
    public var language:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case companyId
        case id
        case name
        case headerLeftCell
        case headerMiddleCell
        case headerRightCell
        case bodyCell
        case footerLeftCell
        case footerMiddleCell
        case footerRightCell
        case messageTemplate
        case language
        case modifiedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        headerLeftCell = try container.decodeIfPresent(String.self, forKey: .headerLeftCell)
        headerMiddleCell = try container.decodeIfPresent(String.self, forKey: .headerMiddleCell)
        headerRightCell = try container.decodeIfPresent(String.self, forKey: .headerRightCell)
        bodyCell = try container.decodeIfPresent(String.self, forKey: .bodyCell)
        footerLeftCell = try container.decodeIfPresent(String.self, forKey: .footerLeftCell)
        footerMiddleCell = try container.decodeIfPresent(String.self, forKey: .footerMiddleCell)
        footerRightCell = try container.decodeIfPresent(String.self, forKey: .footerRightCell)
        messageTemplate = try container.decodeIfPresent(String.self, forKey: .messageTemplate)
        language = try container.decodeIfPresent(String.self, forKey: .language)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
        if id != nil { try container.encode(id, forKey: .id) }
        if name != nil { try container.encode(name, forKey: .name) }
        if headerLeftCell != nil { try container.encode(headerLeftCell, forKey: .headerLeftCell) }
        if headerMiddleCell != nil { try container.encode(headerMiddleCell, forKey: .headerMiddleCell) }
        if headerRightCell != nil { try container.encode(headerRightCell, forKey: .headerRightCell) }
        if bodyCell != nil { try container.encode(bodyCell, forKey: .bodyCell) }
        if footerLeftCell != nil { try container.encode(footerLeftCell, forKey: .footerLeftCell) }
        if footerMiddleCell != nil { try container.encode(footerMiddleCell, forKey: .footerMiddleCell) }
        if footerRightCell != nil { try container.encode(footerRightCell, forKey: .footerRightCell) }
        if messageTemplate != nil { try container.encode(messageTemplate, forKey: .messageTemplate) }
        if language != nil { try container.encode(language, forKey: .language) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
    }
}

public class PrintoutBase : BaseModel
{
    // @Required()
    public var companyId:String?

    public var id:Int
    // @Required()
    public var name:String?

    public var headerLeftCell:String
    public var headerMiddleCell:String
    public var headerRightCell:String
    // @Required()
    public var bodyCell:String?

    public var footerLeftCell:String
    public var footerMiddleCell:String
    public var footerRightCell:String
    public var modifiedDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case companyId
        case id
        case name
        case headerLeftCell
        case headerMiddleCell
        case headerRightCell
        case bodyCell
        case footerLeftCell
        case footerMiddleCell
        case footerRightCell
        case modifiedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        headerLeftCell = try container.decodeIfPresent(String.self, forKey: .headerLeftCell)
        headerMiddleCell = try container.decodeIfPresent(String.self, forKey: .headerMiddleCell)
        headerRightCell = try container.decodeIfPresent(String.self, forKey: .headerRightCell)
        bodyCell = try container.decodeIfPresent(String.self, forKey: .bodyCell)
        footerLeftCell = try container.decodeIfPresent(String.self, forKey: .footerLeftCell)
        footerMiddleCell = try container.decodeIfPresent(String.self, forKey: .footerMiddleCell)
        footerRightCell = try container.decodeIfPresent(String.self, forKey: .footerRightCell)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
        if id != nil { try container.encode(id, forKey: .id) }
        if name != nil { try container.encode(name, forKey: .name) }
        if headerLeftCell != nil { try container.encode(headerLeftCell, forKey: .headerLeftCell) }
        if headerMiddleCell != nil { try container.encode(headerMiddleCell, forKey: .headerMiddleCell) }
        if headerRightCell != nil { try container.encode(headerRightCell, forKey: .headerRightCell) }
        if bodyCell != nil { try container.encode(bodyCell, forKey: .bodyCell) }
        if footerLeftCell != nil { try container.encode(footerLeftCell, forKey: .footerLeftCell) }
        if footerMiddleCell != nil { try container.encode(footerMiddleCell, forKey: .footerMiddleCell) }
        if footerRightCell != nil { try container.encode(footerRightCell, forKey: .footerRightCell) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
    }
}

public class BaseModel : Codable
{
    required public init(){}
}

public class ReportQueryResponse : Codable
{
    public var id:Int
    public var companyId:String
    public var name:String

    required public init(){}
}

public class AccessKeyTypeResponse : Codable
{
    public var id:Int
    public var keyType:String
    public var Description:String

    required public init(){}
}

Swift ReportQuery DTOs

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

HTTP + JSV

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

GET /bookings/reports/ HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Name: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}