| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /bookings/reports/ | Get all reports | Get a list of all existing reports. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class BookingPrintout
: BaseModel
{
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual string Name { get; set; }
public virtual string HeaderLeftCell { get; set; }
public virtual string HeaderMiddleCell { get; set; }
public virtual string HeaderRightCell { get; set; }
[Required]
public virtual string BodyCell { get; set; }
public virtual string FooterLeftCell { get; set; }
public virtual string FooterMiddleCell { get; set; }
public virtual string FooterRightCell { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
public partial class BookingPrintoutQueryResponse
{
///<summary>
///Report id
///</summary>
[ApiMember(Description="Report id")]
public virtual int Id { get; set; }
///<summary>
///Report Name
///</summary>
[ApiMember(Description="Report Name")]
public virtual string Name { get; set; }
///<summary>
///Report header left cell content
///</summary>
[ApiMember(Description="Report header left cell content", IsRequired=true)]
public virtual string HeaderLeftCell { get; set; }
///<summary>
///Report header middle cell content
///</summary>
[ApiMember(Description="Report header middle cell content", IsRequired=true)]
public virtual string HeaderMiddleCell { get; set; }
///<summary>
///Report header right cell content
///</summary>
[ApiMember(Description="Report header right cell content", IsRequired=true)]
public virtual string HeaderRightCell { get; set; }
///<summary>
///Report body cell content
///</summary>
[ApiMember(Description="Report body cell content", IsRequired=true)]
public virtual string BodyCell { get; set; }
///<summary>
///Report footer left cell content
///</summary>
[ApiMember(Description="Report footer left cell content", IsRequired=true)]
public virtual string FooterLeftCell { get; set; }
///<summary>
///Report footer middle cell content
///</summary>
[ApiMember(Description="Report footer middle cell content", IsRequired=true)]
public virtual string FooterMiddleCell { get; set; }
///<summary>
///Report footer right cell content
///</summary>
[ApiMember(Description="Report footer right cell content", IsRequired=true)]
public virtual string FooterRightCell { get; set; }
}
[ValidateRequest("IsAuthenticated")]
public partial class ReportQuery
: QueryDb<BookingPrintout, BookingPrintoutQueryResponse>, ICompany
{
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///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>
///</summary>
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=2)]
public virtual int? Take { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}