| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /reports/booking/printout | Get all reports used for booking export |
|---|
// @DataContract
export class QueryBase
{
/** @description 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 Skip?: number;
/** @description 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 Take?: number;
/** @description 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 OrderBy: string;
/** @description 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 OrderByDesc: string;
/** @description 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 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 BookingPrintoutQueryResponse
{
/** @description Report id */
// @ApiMember(Description="Report id")
public Id: number;
/** @description Report Name */
// @ApiMember(Description="Report Name")
public Name: string;
/** @description Report header left cell content */
// @ApiMember(Description="Report header left cell content", IsRequired=true)
public HeaderLeftCell: string;
/** @description Report header middle cell content */
// @ApiMember(Description="Report header middle cell content", IsRequired=true)
public HeaderMiddleCell: string;
/** @description Report header right cell content */
// @ApiMember(Description="Report header right cell content", IsRequired=true)
public HeaderRightCell: string;
/** @description Report body cell content */
// @ApiMember(Description="Report body cell content", IsRequired=true)
public BodyCell: string;
/** @description Report footer left cell content */
// @ApiMember(Description="Report footer left cell content", IsRequired=true)
public FooterLeftCell: string;
/** @description Report footer middle cell content */
// @ApiMember(Description="Report footer middle cell content", IsRequired=true)
public FooterMiddleCell: string;
/** @description Report footer right cell content */
// @ApiMember(Description="Report footer right cell content", IsRequired=true)
public FooterRightCell: string;
public constructor(init?: Partial<BookingPrintoutQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class BookingPrintout 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<BookingPrintout>) { super(init); (Object as any).assign(this, init); }
}
// @ValidateRequest(Validator="IsAuthenticated")
export class BookingPrintoutQuery extends QueryDb<BookingPrintout, BookingPrintoutQueryResponse> implements ICompany
{
/** @description Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used */
// @ApiMember(Description="Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used", ParameterType="query")
public CompanyId?: string;
/** @description Report id */
// @ApiMember(Description="Report id", ParameterType="query")
public Id?: number;
public constructor(init?: Partial<BookingPrintoutQuery>) { 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<AccessKeyTypeResponse>
{
// @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<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
TypeScript BookingPrintoutQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports/booking/printout HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Name: String,
HeaderLeftCell: String,
HeaderMiddleCell: String,
HeaderRightCell: String,
BodyCell: String,
FooterLeftCell: String,
FooterMiddleCell: String,
FooterRightCell: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}