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

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class CompanyTrialQueryResponse
            Public Overridable Property TrialTypeId As Integer
            Public Overridable Property TrialType As TrialQueryResponse
            Public Overridable Property Started As Nullable(Of Date)
            Public Overridable Property Created As Date
            Public Overridable Property ValidTo As Nullable(Of Date)
            Public Overridable Property Active As Boolean
        End Class

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class CompanyTrialsQuery
            Implements 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 Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Trial Id
            '''</Summary>
            <ApiMember(Description:="Trial Id", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property Id As Integer
        End Class

        Public Partial Class TrialQueryResponse
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property TrialDays As Integer
        End Class
    End Namespace
End Namespace

VB.NET 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: api.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}