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

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type CompanyTrialsQuery() = 
        ///<summary>
        ///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 
        ///</summary>
        [<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Trial Id
        ///</summary>
        [<ApiMember(Description="Trial Id", IsRequired=true, ParameterType="query")>]
        member val Id:Int32 = new Int32() with get,set

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

GET /trials/company/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
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}