| 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 net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@ValidateRequest(Validator="IsAuthenticated")
open class ReportQuery : QueryDb<BookingPrintout, BookingPrintoutQueryResponse>(), 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.")
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)
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)
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)
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)
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)
var Include:String? = null
@DataMember(Order=6)
var Fields:String? = null
@DataMember(Order=7)
var Meta:HashMap<String,String> = HashMap<String,String>()
}
open class BookingPrintout : BaseModel()
{
@Required()
var CompanyId:UUID? = null
var Id:Int? = null
@Required()
var Name:String? = null
var HeaderLeftCell:String? = null
var HeaderMiddleCell:String? = null
var HeaderRightCell:String? = null
@Required()
var BodyCell:String? = null
var FooterLeftCell:String? = null
var FooterMiddleCell:String? = null
var FooterRightCell:String? = null
var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class BookingPrintoutQueryResponse
{
/**
* Report id
*/
@ApiMember(Description="Report id")
var Id:Int? = null
/**
* Report Name
*/
@ApiMember(Description="Report Name")
var Name:String? = null
/**
* Report header left cell content
*/
@ApiMember(Description="Report header left cell content", IsRequired=true)
var HeaderLeftCell:String? = null
/**
* Report header middle cell content
*/
@ApiMember(Description="Report header middle cell content", IsRequired=true)
var HeaderMiddleCell:String? = null
/**
* Report header right cell content
*/
@ApiMember(Description="Report header right cell content", IsRequired=true)
var HeaderRightCell:String? = null
/**
* Report body cell content
*/
@ApiMember(Description="Report body cell content", IsRequired=true)
var BodyCell:String? = null
/**
* Report footer left cell content
*/
@ApiMember(Description="Report footer left cell content", IsRequired=true)
var FooterLeftCell:String? = null
/**
* Report footer middle cell content
*/
@ApiMember(Description="Report footer middle cell content", IsRequired=true)
var FooterMiddleCell:String? = null
/**
* Report footer right cell content
*/
@ApiMember(Description="Report footer right cell content", IsRequired=true)
var FooterRightCell:String? = null
}
@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
var Offset:Int? = null
@DataMember(Order=2)
var Total:Int? = null
@DataMember(Order=3)
var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()
@DataMember(Order=4)
var Meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
var Id:Int? = null
var KeyType:String? = null
var Description:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfBookingPrintoutQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:BookingPrintoutQueryResponse>
<d2p1:BodyCell>String</d2p1:BodyCell>
<d2p1:FooterLeftCell>String</d2p1:FooterLeftCell>
<d2p1:FooterMiddleCell>String</d2p1:FooterMiddleCell>
<d2p1:FooterRightCell>String</d2p1:FooterRightCell>
<d2p1:HeaderLeftCell>String</d2p1:HeaderLeftCell>
<d2p1:HeaderMiddleCell>String</d2p1:HeaderMiddleCell>
<d2p1:HeaderRightCell>String</d2p1:HeaderRightCell>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:BookingPrintoutQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfBookingPrintoutQueryResponseWg5EthtI>