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.

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); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class AddCompanyTrial implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Id of the trial type */
    // @ApiMember(Description="Id of the trial type", IsRequired=true)
    public TrialTypeId: number;

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

TypeScript AddCompanyTrial 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.

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

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