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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class AddCompanyTrial : 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.")
    public var companyId:String?

    /**
    * Id of the trial type
    */
    // @ApiMember(Description="Id of the trial type", IsRequired=true)
    public var trialTypeId: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 AddCompanyTrial DTOs

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

HTTP + XML

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: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddCompanyTrial xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <TrialTypeId>0</TrialTypeId>
</AddCompanyTrial>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyTrialQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Created>0001-01-01T00:00:00</Created>
  <Started>0001-01-01T00:00:00</Started>
  <TrialType>
    <Id>0</Id>
    <Name>String</Name>
    <TrialDays>0</TrialDays>
  </TrialType>
  <TrialTypeId>0</TrialTypeId>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</CompanyTrialQueryResponse>