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

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class AddCompanyTrial
            Implements ICompany
            '''<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.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Id of the trial type
            '''</Summary>
            <ApiMember(Description:="Id of the trial type", IsRequired:=true)>
            Public Overridable Property TrialTypeId As Integer
        End Class

        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

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

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","TrialTypeId":0}
HTTP/1.1 200 OK
Content-Type: application/json
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}