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

export class TrialQueryResponse
{
    public Id: number;
    public Name: string;
    public TrialDays: number;

    public constructor(init?: Partial<TrialQueryResponse>) { (Object as any).assign(this, init); }
}

export class CompanyTrialQueryResponse
{
    public TrialTypeId: number;
    public TrialType: TrialQueryResponse;
    public Started?: string;
    public Created: string;
    public ValidTo?: string;
    public Active: boolean;

    public constructor(init?: Partial<CompanyTrialQueryResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class CompanyTrialsQuery implements ICompany
{
    /** @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  */
    // @ApiMember(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 ", IsRequired=true, ParameterType="query")
    public CompanyId: string;

    /** @description Trial Id */
    // @ApiMember(Description="Trial Id", IsRequired=true, ParameterType="query")
    public Id: number;

    public constructor(init?: Partial<CompanyTrialsQuery>) { (Object as any).assign(this, init); }
}

TypeScript CompanyTrialsQuery DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}