BokaMera.API.Host

<back to all web services

CreateLicense

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/licenses/companyAdd new license to a companyAdd a new license to 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 CreateLicense : 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

    /**
    * Id of the license type
    */
    @ApiMember(Description="Id of the license type", IsRequired=true)
    var TypeId:Int? = null

    /**
    * Any metadata connected to the license. In example for domain license set the requested domain name here.
    */
    @ApiMember(Description="Any metadata connected to the license. In example for domain license set the requested domain name here.", IsRequired=true)
    var MetaData:String? = null

    /**
    * If you want to update your company billing information. Note, if no billing information is added before, you need to set this.
    */
    @ApiMember(Description="If you want to update your company billing information. Note, if no billing information is added before, you need to set this.")
    var BillingInformation:BillingInformationResponse? = null
}

open class BillingInformationResponse
{
    /**
    * The company id.
    */
    @ApiMember(Description="The company id.")
    var CompanyId:UUID? = null

    /**
    * The prefered billing method.
    */
    @ApiMember(Description="The prefered billing method.", IsRequired=true)
    var BillingMethodId:Int? = null

    /**
    * The name that should be printed on the billing information, normally this would be your company name.
    */
    @ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")
    var Name:String? = null

    /**
    * If you want to add the attention to the billing address.
    */
    @ApiMember(Description="If you want to add the attention to the billing address.")
    var Attention:String? = null

    /**
    * The street for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")
    var Street1:String? = null

    /**
    * The street for the billing adress.
    */
    @ApiMember(Description="The street for the billing adress.")
    var Street2:String? = null

    /**
    * The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")
    var ZipCode:String? = null

    /**
    * The city for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")
    var City:String? = null

    /**
    * The country for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")
    var CountryId:String? = null

    /**
    * The billing email. This is required when having email invoice as billing method.
    */
    @ApiMember(Description="The billing email. This is required when having email invoice as billing method.")
    var Email:String? = null

    /**
    * The company global location number.
    */
    @ApiMember(Description="The company global location number.")
    var GLN:String? = null

    /**
    * You're internal rereference.
    */
    @ApiMember(Description="You're internal rereference.")
    var ReferenceLine1:String? = null

    /**
    * You're internal rereference.
    */
    @ApiMember(Description="You're internal rereference.")
    var ReferenceLine2:String? = null

    /**
    * The billing payment terms in days. This is default 15 days.
    */
    @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
    var PaymentTermsDays:Int? = null

    /**
    * The company vat registration number.
    */
    @ApiMember(Description="The company vat registration number.")
    var VatRegistrationNumber:String? = null

    /**
    * The billing method options to choose from
    */
    @ApiMember(Description="The billing method options to choose from")
    var BillingMethodOptions:ArrayList<BillingMethod> = ArrayList<BillingMethod>()
}

open class BillingMethod : BaseModel()
{
    var BillingMethodCountriesRelation:ArrayList<BillingMethodCountriesRelation> = ArrayList<BillingMethodCountriesRelation>()
    @Required()
    var Name:String? = null

    @Required()
    var Description:String? = null

    var ModifiedDate:Date? = null
    var Id:Int? = null
}

open class BaseModel
{
}

open class BillingMethodCountriesRelation : BaseModel()
{
    @Required()
    var BillingMethodId:Int? = null

    @Required()
    var CountryId:String? = null

    var ModifiedDate:Date? = 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 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 CreateLicense 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 HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	TypeId: 0,
	MetaData: String,
	BillingInformation: 
	{
		BillingMethodId: 0,
		Name: String,
		Attention: String,
		Street1: String,
		Street2: String,
		ZipCode: String,
		City: String,
		CountryId: String,
		Email: String,
		GLN: String,
		ReferenceLine1: String,
		ReferenceLine2: String,
		PaymentTermsDays: 0,
		VatRegistrationNumber: String,
		BillingMethodOptions: 
		[
			{
				BillingMethodCountriesRelation: 
				[
					{
						BillingMethodId: 0,
						CountryId: String,
						ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
					}
				],
				Name: String,
				Description: String,
				ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
				Id: 0
			}
		]
	}
}
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
}