Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
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. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Id | path | int | Yes | Id of the license |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
TypeId | form | int | No | |
Type | form | LicenseTypeQueryResponse | No | |
ValidFrom | form | DateTime | No | |
ValidTo | form | DateTime | No | |
MetaData | form | string | No | |
Active | form | bool | No | |
Canceled | form | bool | No | |
Updated | form | DateTime | No | |
Created | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The license type id |
Name | form | string | No | The license type name |
Description | form | string | No | The license type description |
IsExtraLicenseOption | form | bool | No | If the license type is not a standard license but instead an extra license option. An example would be sending new letter license. |
PeriodOfNoticeDays | form | int | No | The period of notice for the license in days. |
Items | form | List<LicenseItemsResponse> | No | The license items for the license type |
Prices | form | List<LicensePrice> | No | The license prices in each country for the license type |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
AllowedItems | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Country | form | Country | No | |
MonthlyPayment | form | bool | No | |
LicenseTypeId | form | int | Yes | |
CountryId | form | string | Yes | |
Price | form | int | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CurrencyId | form | string | No | |
CurrencyInfo | form | Currency | No | |
Name | form | string | Yes | |
Culture | form | string | No | |
TimeZone | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
CurrencySign | form | string | Yes | |
Active | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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.bokamera.se Accept: text/jsv
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 }