BokaMera.API.Host

<back to all web services

BookingPrintoutQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/reports/booking/printoutGet all reports used for booking export
BookingPrintoutQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company you want to see add a token for, if blank and you are an admin, your company id will be used
Idqueryint?NoReport id
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BookingPrintout Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
NameformstringYes
HeaderLeftCellformstringNo
HeaderMiddleCellformstringNo
HeaderRightCellformstringNo
BodyCellformstringYes
FooterLeftCellformstringNo
FooterMiddleCellformstringNo
FooterRightCellformstringNo
MessageTemplateformstringNo
LanguageformstringNo
ModifiedDateformDateTimeOffset?No
PrintoutBase Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
NameformstringYes
HeaderLeftCellformstringNo
HeaderMiddleCellformstringNo
HeaderRightCellformstringNo
BodyCellformstringYes
FooterLeftCellformstringNo
FooterMiddleCellformstringNo
FooterRightCellformstringNo
ModifiedDateformDateTimeOffset?No
PrintoutQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoReport id
NameformstringYesReport Name
HeaderLeftCellformstringYesReport header left cell content
HeaderMiddleCellformstringYesReport header middle cell content
HeaderRightCellformstringYesReport header right cell content
BodyCellformstringYesReport body cell content
FooterLeftCellformstringYesReport footer left cell content
FooterMiddleCellformstringYesReport footer middle cell content
FooterRightCellformstringYesReport footer right cell content
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: testapi.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
		}
	}
}