| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /licenses/company | Add new license to a company | Add a new license to the company for the logged in user. |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type LicenseItemsResponse() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val AllowedItems:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type Currency() =
inherit BaseModel()
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val CurrencySign:String = null with get,set
[<Required>]
member val Active:Boolean = new Boolean() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:String = null with get,set
[<AllowNullLiteral>]
type Country() =
inherit BaseModel()
[<References(typeof<Currency>)>]
member val CurrencyId:String = null with get,set
member val CurrencyInfo:Currency = null with get,set
[<Required>]
member val Name:String = null with get,set
member val Culture:String = null with get,set
member val TimeZone:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:String = null with get,set
[<AllowNullLiteral>]
type LicensePrice() =
inherit BaseModel()
[<Ignore>]
member val Country:Country = null with get,set
[<Ignore>]
member val MonthlyPayment:Boolean = new Boolean() with get,set
[<Required>]
member val LicenseTypeId:Int32 = new Int32() with get,set
[<Required>]
member val CountryId:String = null with get,set
[<Required>]
member val Price:Int32 = new Int32() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<AllowNullLiteral>]
type LicenseTypeQueryResponse() =
///<summary>
///The license type id
///</summary>
[<ApiMember(Description="The license type id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The license type name
///</summary>
[<ApiMember(Description="The license type name")>]
member val Name:String = null with get,set
///<summary>
///The license type description
///</summary>
[<ApiMember(Description="The license type description")>]
member val Description:String = null with get,set
///<summary>
///If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
///</summary>
[<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.")>]
member val IsExtraLicenseOption:Boolean = new Boolean() with get,set
///<summary>
///The period of notice for the license in days.
///</summary>
[<ApiMember(Description="The period of notice for the license in days.")>]
member val PeriodOfNoticeDays:Int32 = new Int32() with get,set
///<summary>
///The license items for the license type
///</summary>
[<ApiMember(Description="The license items for the license type")>]
member val Items:ResizeArray<LicenseItemsResponse> = new ResizeArray<LicenseItemsResponse>() with get,set
///<summary>
///The license prices in each country for the license type
///</summary>
[<ApiMember(Description="The license prices in each country for the license type")>]
member val Prices:ResizeArray<LicensePrice> = new ResizeArray<LicensePrice>() with get,set
[<AllowNullLiteral>]
type CompanyLicenseQueryResponse() =
member val Id:Int32 = new Int32() with get,set
member val TypeId:Int32 = new Int32() with get,set
member val Type:LicenseTypeQueryResponse = null with get,set
member val ValidFrom:DateTime = new DateTime() with get,set
member val ValidTo:DateTime = new DateTime() with get,set
member val MetaData:String = null with get,set
member val Active:Boolean = new Boolean() with get,set
member val Canceled:Boolean = new Boolean() with get,set
member val Updated:DateTime = new DateTime() with get,set
member val Created:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type BillingMethodCountriesRelation() =
inherit BaseModel()
[<Required>]
member val BillingMethodId:Int32 = new Int32() with get,set
[<Required>]
member val CountryId:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<AllowNullLiteral>]
type BillingMethod() =
inherit BaseModel()
member val BillingMethodCountriesRelation:ResizeArray<BillingMethodCountriesRelation> = new ResizeArray<BillingMethodCountriesRelation>() with get,set
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val Description:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val Id:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type BillingInformationResponse() =
///<summary>
///The company id.
///</summary>
[<ApiMember(Description="The company id.")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The prefered billing method.
///</summary>
[<ApiMember(Description="The prefered billing method.", IsRequired=true)>]
member val BillingMethodId:Int32 = new Int32() with get,set
///<summary>
///The name that should be printed on the billing information, normally this would be your company name.
///</summary>
[<ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")>]
member val Name:String = null with get,set
///<summary>
///If you want to add the attention to the billing address.
///</summary>
[<ApiMember(Description="If you want to add the attention to the billing address.")>]
member val Attention:String = null with get,set
///<summary>
///The street for the billing adress. This is required when having postal invoice as billing method.
///</summary>
[<ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")>]
member val Street1:String = null with get,set
///<summary>
///The street for the billing adress.
///</summary>
[<ApiMember(Description="The street for the billing adress.")>]
member val Street2:String = null with get,set
///<summary>
///The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
///</summary>
[<ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")>]
member val ZipCode:String = null with get,set
///<summary>
///The city for the billing adress. This is required when having postal invoice as billing method.
///</summary>
[<ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")>]
member val City:String = null with get,set
///<summary>
///The country for the billing adress. This is required when having postal invoice as billing method.
///</summary>
[<ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")>]
member val CountryId:String = null with get,set
///<summary>
///The billing email. This is required when having email invoice as billing method.
///</summary>
[<ApiMember(Description="The billing email. This is required when having email invoice as billing method.")>]
member val Email:String = null with get,set
///<summary>
///The company global location number.
///</summary>
[<ApiMember(Description="The company global location number.")>]
member val GLN:String = null with get,set
///<summary>
///You're internal rereference.
///</summary>
[<ApiMember(Description="You're internal rereference.")>]
member val ReferenceLine1:String = null with get,set
///<summary>
///You're internal rereference.
///</summary>
[<ApiMember(Description="You're internal rereference.")>]
member val ReferenceLine2:String = null with get,set
///<summary>
///The billing payment terms in days. This is default 15 days.
///</summary>
[<ApiMember(Description="The billing payment terms in days. This is default 15 days.")>]
member val PaymentTermsDays:Int32 = new Int32() with get,set
///<summary>
///The company vat registration number.
///</summary>
[<ApiMember(Description="The company vat registration number.")>]
member val VatRegistrationNumber:String = null with get,set
///<summary>
///The billing method options to choose from
///</summary>
[<ApiMember(Description="The billing method options to choose from")>]
member val BillingMethodOptions:ResizeArray<BillingMethod> = new ResizeArray<BillingMethod>() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type CreateLicense() =
///<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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Id of the license type
///</summary>
[<ApiMember(Description="Id of the license type", IsRequired=true)>]
member val TypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Any metadata connected to the license. In example for domain license set the requested domain name here.
///</summary>
[<ApiMember(Description="Any metadata connected to the license. In example for domain license set the requested domain name here.", IsRequired=true)>]
member val MetaData:String = null with get,set
///<summary>
///If you want to update your company billing information. Note, if no billing information is added before, you need to set this.
///</summary>
[<ApiMember(Description="If you want to update your company billing information. Note, if no billing information is added before, you need to set this.")>]
member val BillingInformation:BillingInformationResponse = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
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}