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.

// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class ReportQueryResponse
{
    public Id: number;
    public CompanyId: string;
    public Name: string;

    public constructor(init?: Partial<ReportQueryResponse>) { (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class PrintoutBase extends BaseModel
{
    // @Required()
    public CompanyId: string;

    public Id: number;
    // @Required()
    public Name: string;

    public HeaderLeftCell?: string;
    public HeaderMiddleCell?: string;
    public HeaderRightCell?: string;
    // @Required()
    public BodyCell: string;

    public FooterLeftCell?: string;
    public FooterMiddleCell?: string;
    public FooterRightCell?: string;
    public ModifiedDate?: string;

    public constructor(init?: Partial<PrintoutBase>) { super(init); (Object as any).assign(this, init); }
}

export class BookingPrintout extends PrintoutBase
{
    // @Required()
    public CompanyId: string;

    public Id: number;
    // @Required()
    public Name: string;

    public HeaderLeftCell?: string;
    public HeaderMiddleCell?: string;
    public HeaderRightCell?: string;
    // @Required()
    public BodyCell: string;

    public FooterLeftCell?: string;
    public FooterMiddleCell?: string;
    public FooterRightCell?: string;
    public MessageTemplate?: string;
    public Language?: string;
    public ModifiedDate?: string;

    public constructor(init?: Partial<BookingPrintout>) { super(init); (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class ReportQuery extends QueryDb<BookingPrintout, ReportQueryResponse> implements ICompany
{
    /** @description 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 CompanyId?: string;

    public constructor(init?: Partial<ReportQuery>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript ReportQuery 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 /bookings/reports/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}