| 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. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@ValidateRequest(Validator="IsAuthenticated")
open class ReportQuery : QueryDb<BookingPrintout, PrintoutQueryResponse>(), 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.")
override var CompanyId:UUID? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open 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)
open var Skip:Int? = 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)
open var Take:Int? = 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)
open var OrderBy:String? = 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)
open var OrderByDesc:String? = 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)
open var Include:String? = null
@DataMember(Order=6)
open var Fields:String? = null
@DataMember(Order=7)
open var Meta:HashMap<String,String>? = null
}
open class BookingPrintout : PrintoutBase()
{
@Required()
override var CompanyId:UUID? = null
override var Id:Int? = null
@Required()
override var Name:String? = null
override var HeaderLeftCell:String? = null
override var HeaderMiddleCell:String? = null
override var HeaderRightCell:String? = null
@Required()
override var BodyCell:String? = null
override var FooterLeftCell:String? = null
override var FooterMiddleCell:String? = null
override var FooterRightCell:String? = null
override var ModifiedDate:Date? = null
}
open class PrintoutBase : BaseModel()
{
@Required()
open var CompanyId:UUID? = null
open var Id:Int? = null
@Required()
open var Name:String? = null
open var HeaderLeftCell:String? = null
open var HeaderMiddleCell:String? = null
open var HeaderRightCell:String? = null
@Required()
open var BodyCell:String? = null
open var FooterLeftCell:String? = null
open var FooterMiddleCell:String? = null
open var FooterRightCell:String? = null
open var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class PrintoutQueryResponse
{
/**
* Report id
*/
@ApiMember(Description="Report id")
open var Id:Int? = null
/**
* Report Name
*/
@ApiMember(Description="Report Name")
open var Name:String? = null
/**
* Report header left cell content
*/
@ApiMember(Description="Report header left cell content", IsRequired=true)
open var HeaderLeftCell:String? = null
/**
* Report header middle cell content
*/
@ApiMember(Description="Report header middle cell content", IsRequired=true)
open var HeaderMiddleCell:String? = null
/**
* Report header right cell content
*/
@ApiMember(Description="Report header right cell content", IsRequired=true)
open var HeaderRightCell:String? = null
/**
* Report body cell content
*/
@ApiMember(Description="Report body cell content", IsRequired=true)
open var BodyCell:String? = null
/**
* Report footer left cell content
*/
@ApiMember(Description="Report footer left cell content", IsRequired=true)
open var FooterLeftCell:String? = null
/**
* Report footer middle cell content
*/
@ApiMember(Description="Report footer middle cell content", IsRequired=true)
open var FooterMiddleCell:String? = null
/**
* Report footer right cell content
*/
@ApiMember(Description="Report footer right cell content", IsRequired=true)
open var FooterRightCell:String? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var Offset:Int? = null
@DataMember(Order=2)
open var Total:Int? = null
@DataMember(Order=3)
open var Results:ArrayList<AccessKeyTypeResponse>? = null
@DataMember(Order=4)
open var Meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
open var Id:Int? = null
open var KeyType:String? = null
open var Description:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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: api.bookmore.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}