Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /trials/company/ | Get all company started trials | Get all trials that have been started for a specific company |
---|
import Foundation
import ServiceStack
// @ValidateRequest(Validator="IsAuthenticated")
public class CompanyTrialsQuery : ICompany, Codable
{
/**
* 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.", 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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: api.bookmore.com 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 }