BokaMera.API.Host

<back to all web services

AddCompanyTrial

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/trials/company/Add new trial to a companyStart a new trial to the company for the logged in user.
AddCompanyTrial Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
TrialTypeIdbodyintYesId of the trial type
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.

POST /trials/company/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	TrialTypeId: 0
}
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
}