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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	TrialTypeId: 0
}
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
}