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.
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TrialQueryResponse:
    id: int = 0
    name: Optional[str] = None
    trial_days: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyTrialQueryResponse:
    trial_type_id: int = 0
    trial_type: Optional[TrialQueryResponse] = None
    started: Optional[datetime.datetime] = None
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    valid_to: Optional[datetime.datetime] = None
    active: bool = False


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddCompanyTrial(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="Id of the trial type", IsRequired=true)
    trial_type_id: int = 0
    """
    Id of the trial type
    """

Python AddCompanyTrial DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AddCompanyTrial xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <TrialTypeId>0</TrialTypeId>
</AddCompanyTrial>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyTrialQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Created>0001-01-01T00:00:00</Created>
  <Started>0001-01-01T00:00:00</Started>
  <TrialType>
    <Id>0</Id>
    <Name>String</Name>
    <TrialDays>0</TrialDays>
  </TrialType>
  <TrialTypeId>0</TrialTypeId>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</CompanyTrialQueryResponse>