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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TrialQueryResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val TrialDays:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CompanyTrialQueryResponse() = 
        member val TrialTypeId:Int32 = new Int32() with get,set
        member val TrialType:TrialQueryResponse = null with get,set
        member val Started:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val ValidTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Active:Boolean = new Boolean() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type AddCompanyTrial() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Id of the trial type
        ///</summary>
        [<ApiMember(Description="Id of the trial type", IsRequired=true)>]
        member val TrialTypeId:Int32 = new Int32() with get,set

F# 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>