Required role: | superadmin |
DELETE | /superadmin/company/{Id} | Deletes a customer and everything realted to customer, including administrators and bookings etc. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | Enter the companyId for the customer |
Id | path | Guid | Yes | Id (guid) of company you wish to delete. |
GotApprovedByAdmin | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid? | No | |
ActiveLicenses | form | List<License> | No | |
Comment | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | LicenseType | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
TypeId | form | int | Yes | |
ValidFrom | form | DateTime | Yes | |
ValidTo | form | DateTime | Yes | |
Active | form | bool | Yes | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
MetaData | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LicenseItems | form | IList<LicenseTypeItem> | No | |
Prices | form | IList<LicensePrice> | No | |
IsFree | form | bool | No | |
PeriodOfNoticeDays | form | int | No | |
NextLicenseOption | form | LicenseType | No | |
Name | form | string | Yes | |
Description | form | string | Yes | |
ExtraLicenseOption | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Active | form | bool | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
LicenseType | form | LicenseType | No | |
LicenseTypesId | form | int | Yes | |
LicenseItemsId | form | int | Yes | |
NumberOfItems | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /superadmin/company/{Id} HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DeletedCustomerInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <ActiveLicenses xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db"> <d2p1:License> <d2p1:Active>false</d2p1:Active> <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId> <d2p1:Created>0001-01-01T00:00:00</d2p1:Created> <d2p1:Id>0</d2p1:Id> <d2p1:MetaData>String</d2p1:MetaData> <d2p1:ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </d2p1:ModifiedDate> <d2p1:Type> <d2p1:Active>false</d2p1:Active> <d2p1:Description>String</d2p1:Description> <d2p1:ExtraLicenseOption>false</d2p1:ExtraLicenseOption> <d2p1:Id>0</d2p1:Id> <d2p1:LicenseItems i:nil="true" /> <d2p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </d2p1:ModifiedDate> <d2p1:Name>String</d2p1:Name> <d2p1:Prices i:nil="true" /> </d2p1:Type> <d2p1:TypeId>0</d2p1:TypeId> <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated> <d2p1:ValidFrom>0001-01-01T00:00:00</d2p1:ValidFrom> <d2p1:ValidTo>0001-01-01T00:00:00</d2p1:ValidTo> </d2p1:License> </ActiveLicenses> <Comment>String</Comment> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> </DeletedCustomerInfoResponse>