BokaMera.API.Host

<back to all web services

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 companyCancel 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.
CancelLicense Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesId of the license
CompanyLicenseQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeIdformintNo
TypeformLicenseTypeQueryResponseNo
ValidFromformDateTimeNo
ValidToformDateTimeNo
MetaDataformstringNo
ActiveformboolNo
CanceledformboolNo
UpdatedformDateTimeNo
CreatedformDateTimeNo
LicenseTypeQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe license type id
NameformstringNoThe license type name
DescriptionformstringNoThe license type description
IsExtraLicenseOptionformboolNoIf the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
PeriodOfNoticeDaysformintNoThe period of notice for the license in days.
ItemsformList<LicenseItemsResponse>NoThe license items for the license type
PricesformList<LicensePrice>NoThe license prices in each country for the license type
LicenseItemsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
AllowedItemsformintNo
LicensePrice Parameters:
NameParameterData TypeRequiredDescription
CountryformCountryNo
MonthlyPaymentformboolNo
LicenseTypeIdformintYes
CountryIdformstringYes
PriceformintYes
ModifiedDateformDateTimeOffset?No
Country Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
NameformstringYes
CultureformstringNo
TimeZoneformstringNo
ModifiedDateformDateTimeOffset?No
IdformstringYes
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CurrencySignformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformstringYes

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: testapi.bokamera.se 
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}