BokaMera.API.Host

<back to all web services

CompanyTrialsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/trials/company/Get all company started trialsGet all trials that have been started for a specific company
CompanyTrialsQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesEnter the company and id you want to see the information for a resource, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown
IdqueryintYesTrial Id
CompanyTrialQueryResponse Parameters:
NameParameterData TypeRequiredDescription
TrialTypeIdformintNo
TrialTypeformTrialQueryResponseNo
StartedformDateTime?No
CreatedformDateTimeNo
ValidToformDateTime?No
ActiveformboolNo
TrialQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
TrialDaysformintNo

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 /trials/company/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TrialTypeId: 0,
	TrialType: 
	{
		Id: 0,
		Name: String,
		TrialDays: 0
	},
	Started: "0001-01-01T00:00:00",
	ValidTo: "0001-01-01T00:00:00",
	Active: False
}