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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class CompanyTrialQueryResponse
    {
        public virtual int TrialTypeId { get; set; }
        public virtual TrialQueryResponse TrialType { get; set; }
        public virtual DateTime? Started { get; set; }
        public virtual DateTime Created { get; set; }
        public virtual DateTime? ValidTo { get; set; }
        public virtual bool Active { get; set; }
    }

    [ValidateRequest("IsAuthenticated")]
    public partial class CompanyTrialsQuery
        : ICompany
    {
        ///<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")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Trial Id
        ///</summary>
        [ApiMember(Description="Trial Id", IsRequired=true, ParameterType="query")]
        public virtual int Id { get; set; }
    }

    public partial class TrialQueryResponse
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual int TrialDays { get; set; }
    }

}

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

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