BokaMera.API.Host

EndAllLicenses

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

The following routes are available for this service:
POST	/licenses/company/delete	End all licenses	End all licenses on the company for the logged in user.

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


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class EndAllLicenses : 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.")
    var CompanyId:UUID? = null

    /**
    * If you want to deactivate the account the booking system also (will not be working during your period of notice).
    */
    @ApiMember(Description="If you want to deactivate the account the booking system also (will not be working during your period of notice).")
    var Deactivate:Boolean? = null

    /**
    * Questionaire with answers from customer why ending license.
    */
    @ApiMember(Description="Questionaire with answers from customer why ending license.")
    var Questionnaire:ArrayList<Questionnaire>? = null
}

open class Questionnaire
{
    var Question:String? = null
    var Value:String? = null
}

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

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

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

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

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

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

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

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

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

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

    @Ignore()
    var MonthlyPayment:Boolean? = null

    @Required()
    var LicenseTypeId:Int? = null

    @Required()
    var CountryId:String? = null

    @Required()
    var Price:Int? = null

    var ModifiedDate:Date? = null
}

open class BaseModel
{
}

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

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

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

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

    @Required()
    var CurrencySign:String? = null

    @Required()
    var Active:Boolean? = null

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

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

POST /licenses/company/delete HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Deactivate: False,
	Questionnaire: 
	[
		{
			Question: String,
			Value: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
}