BokaMera.API.Host

CancelLicense

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
DELETE	/licenses/company/{Id}	Cancel a license to a company	Cancel an existing license to the company for the logged in user. The license will have it end date set to after it's period of notice.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CancelLicense : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    override var CompanyId:UUID? = null

    /**
    * Id of the license
    */
    @ApiMember(Description="Id of the license", IsRequired=true, ParameterType="path")
    open var Id:Int? = null
}

open class CompanyLicenseQueryResponse
{
    open var Id:Int? = null
    open var TypeId:Int? = null
    open var Type:LicenseTypeQueryResponse? = null
    open var ValidFrom:Date? = null
    open var ValidTo:Date? = null
    open var MetaData:String? = null
    open var Active:Boolean? = null
    open var Canceled:Boolean? = null
    open var Updated:Date? = null
    open var Created:Date? = null
}

open class LicenseTypeQueryResponse
{
    /**
    * The license type id
    */
    @ApiMember(Description="The license type id")
    open var Id:Int? = null

    /**
    * The license type name
    */
    @ApiMember(Description="The license type name")
    open var Name:String? = null

    /**
    * The license type description
    */
    @ApiMember(Description="The license type description")
    open var Description:String? = null

    /**
    * If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.
    */
    @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.")
    open var IsExtraLicenseOption:Boolean? = null

    /**
    * The period of notice for the license in days.
    */
    @ApiMember(Description="The period of notice for the license in days.")
    open var PeriodOfNoticeDays:Int? = null

    /**
    * The license items for the license type
    */
    @ApiMember(Description="The license items for the license type")
    open var Items:ArrayList<LicenseItemsResponse>? = null

    /**
    * The license prices in each country for the license type
    */
    @ApiMember(Description="The license prices in each country for the license type")
    open var Prices:ArrayList<LicensePrice>? = null
}

open class LicenseItemsResponse
{
    open var Id:Int? = null
    open var Name:String? = null
    open var AllowedItems:Int? = null
}

open class LicensePrice : BaseModel()
{
    @Ignore()
    open var Country:Country? = null

    @Ignore()
    open var MonthlyPayment:Boolean? = null

    @Required()
    open var LicenseTypeId:Int? = null

    @Required()
    open var CountryId:String? = null

    @Required()
    open var Price:Int? = null

    open var ModifiedDate:Date? = null
}

open class BaseModel
{
}

open class Country : BaseModel()
{
    @References(Type=Currency::class)
    open var CurrencyId:String? = null

    open var CurrencyInfo:Currency? = null
    @Required()
    open var Name:String? = null

    open var Culture:String? = null
    open var TimeZone:String? = null
    open var ModifiedDate:Date? = null
    @Required()
    open var Id:String? = null
}

open class Currency : BaseModel()
{
    @Required()
    open var Name:String? = null

    @Required()
    open var CurrencySign:String? = null

    @Required()
    open var Active:Boolean? = null

    open var ModifiedDate:Date? = null
    @Required()
    open var Id:String? = null
}

Kotlin CancelLicense DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /licenses/company/{Id} HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"TypeId":0,"Type":{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"MonthlyPayment":true,"LicenseTypeId":0,"CountryId":"String","Price":0,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}]},"MetaData":"String","Active":false,"Canceled":false}