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
import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class CompanyTrialsQuery : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * Trial Id
    */
    // @ApiMember(Description="Trial Id", IsRequired=true, ParameterType="query")
    public var id:Int

    required public init(){}
}

public class CompanyTrialQueryResponse : Codable
{
    public var trialTypeId:Int
    public var trialType:TrialQueryResponse
    public var started:Date?
    public var created:Date
    public var validTo:Date?
    public var active:Bool

    required public init(){}
}

public class TrialQueryResponse : Codable
{
    public var id:Int
    public var name:String
    public var trialDays:Int

    required public init(){}
}


Swift CompanyTrialsQuery DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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