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
"use strict";
export class TrialQueryResponse {
    /** @param {{Id?:number,Name?:string,TrialDays?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {number} */
    TrialDays;
}
export class CompanyTrialQueryResponse {
    /** @param {{TrialTypeId?:number,TrialType?:TrialQueryResponse,Started?:string,Created?:string,ValidTo?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TrialTypeId;
    /** @type {TrialQueryResponse} */
    TrialType;
    /** @type {?string} */
    Started;
    /** @type {string} */
    Created;
    /** @type {?string} */
    ValidTo;
    /** @type {boolean} */
    Active;
}
export class CompanyTrialsQuery {
    /** @param {{CompanyId?:string,Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Enter 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  */
    CompanyId;
    /**
     * @type {number}
     * @description Trial Id */
    Id;
}

JavaScript CompanyTrialsQuery DTOs

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