| Requires the role: | superadmin |
| GET | /superadmin/licenses/company | Find licenses for the logged in users company | Find licenses for the logged in users company. |
|---|
// @DataContract
export class QueryBase
{
/** @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
// @DataMember(Order=1)
public Skip?: number;
/** @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
// @DataMember(Order=2)
public Take?: number;
/** @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
// @DataMember(Order=3)
public OrderBy: string;
/** @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
// @DataMember(Order=4)
public OrderByDesc: string;
/** @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
// @DataMember(Order=5)
public Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class LicenseItemsResponse
{
public Id: number;
public Name: string;
public AllowedItems: number;
public constructor(init?: Partial<LicenseItemsResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class Currency extends BaseModel
{
// @Required()
public Name: string;
// @Required()
public CurrencySign: string;
// @Required()
public Active: boolean;
public ModifiedDate?: string;
// @Required()
public Id: string;
public constructor(init?: Partial<Currency>) { super(init); (Object as any).assign(this, init); }
}
export class Country extends BaseModel
{
// @References("typeof(BokaMera.API.ServiceModel.Db.Currency)")
public CurrencyId: string;
public CurrencyInfo: Currency;
// @Required()
public Name: string;
public Culture: string;
public TimeZone: string;
public ModifiedDate?: string;
// @Required()
public Id: string;
public constructor(init?: Partial<Country>) { super(init); (Object as any).assign(this, init); }
}
export class LicensePrice extends BaseModel
{
// @Ignore()
public Country: Country;
// @Ignore()
public MonthlyPayment: boolean;
// @Required()
public LicenseTypeId: number;
// @Required()
public CountryId: string;
// @Required()
public Price: number;
public ModifiedDate?: string;
public constructor(init?: Partial<LicensePrice>) { super(init); (Object as any).assign(this, init); }
}
export class LicenseTypeQueryResponse
{
/** @description The license type id */
// @ApiMember(Description="The license type id")
public Id: number;
/** @description The license type name */
// @ApiMember(Description="The license type name")
public Name: string;
/** @description The license type description */
// @ApiMember(Description="The license type description")
public Description: string;
/** @description 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.")
public IsExtraLicenseOption: boolean;
/** @description The period of notice for the license in days. */
// @ApiMember(Description="The period of notice for the license in days.")
public PeriodOfNoticeDays: number;
/** @description The license items for the license type */
// @ApiMember(Description="The license items for the license type")
public Items: LicenseItemsResponse[];
/** @description The license prices in each country for the license type */
// @ApiMember(Description="The license prices in each country for the license type")
public Prices: LicensePrice[];
public constructor(init?: Partial<LicenseTypeQueryResponse>) { (Object as any).assign(this, init); }
}
export class CompanyLicenseQueryResponse
{
public Id: number;
public TypeId: number;
public Type: LicenseTypeQueryResponse;
public ValidFrom: string;
public ValidTo: string;
public MetaData: string;
public Active: boolean;
public Canceled: boolean;
public Updated: string;
public Created: string;
public constructor(init?: Partial<CompanyLicenseQueryResponse>) { (Object as any).assign(this, init); }
}
export class LicenseTypeItem extends BaseModel
{
// @Ignore()
public Name: string;
// @Ignore()
public LicenseType: LicenseType;
// @Required()
public LicenseTypesId: number;
// @Required()
public LicenseItemsId: number;
// @Required()
public NumberOfItems: number;
public Id: number;
public ModifiedDate?: string;
public constructor(init?: Partial<LicenseTypeItem>) { super(init); (Object as any).assign(this, init); }
}
export class LicenseType extends BaseModel
{
// @Ignore()
public LicenseItems: IList<LicenseTypeItem>;
// @Ignore()
public Prices: IList<LicensePrice>;
// @Ignore()
public PeriodOfNoticeDays: number;
// @Ignore()
public NextLicenseOption: LicenseType;
// @Required()
public Name: string;
// @Required()
public Description: string;
// @Required()
public ExtraLicenseOption: boolean;
public ModifiedDate?: string;
public Active: boolean;
public Id: number;
public constructor(init?: Partial<LicenseType>) { super(init); (Object as any).assign(this, init); }
}
export class License extends BaseModel
{
public Type: LicenseType;
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public TypeId: number;
// @Required()
public ValidFrom: string;
// @Required()
public ValidTo: string;
// @Required()
public Active: boolean;
// @Required()
public Updated: string;
// @Required()
public Created: string;
public ModifiedDate?: string;
public MetaData: string;
public constructor(init?: Partial<License>) { super(init); (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class SuperAdminCompanyLicenseQuery extends QueryDb<License, CompanyLicenseQueryResponse>
{
/** @description 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.")
public CompanyId?: string;
/** @description If you want to include the connected license items */
// @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
public OnlyActiveLicenses: boolean;
/** @description What country you want to list the prices for */
// @ApiMember(DataType="string", Description="What country you want to list the prices for")
public CountryId: string;
/** @description Search by the Meta data information on the license */
// @ApiMember(DataType="string", Description="Search by the Meta data information on the license")
public MetaData: string;
/** @description Id of the license type */
// @ApiMember(Description="Id of the license type")
public TypeId?: number;
/** @description If you want to only select Extra license options */
// @ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")
public IsExtraLicenseOption?: boolean;
/** @description If you want to include the connected license items */
// @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
public IncludeLicenseItems: boolean;
/** @description If you want to include the connected licens prices */
// @ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")
public IncludeLicensePrices: boolean;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<SuperAdminCompanyLicenseQuery>) { super(init); (Object as any).assign(this, init); }
}
export class AccessKeyTypeResponse
{
public Id: number;
public KeyType: string;
public Description: string;
public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: AccessKeyTypeResponse[];
// @DataMember(Order=4)
public Meta: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
TypeScript SuperAdminCompanyLicenseQuery DTOs
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.
GET /superadmin/licenses/company HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfCompanyLicenseQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:CompanyLicenseQueryResponse>
<d2p1:Active>false</d2p1:Active>
<d2p1:Canceled>false</d2p1:Canceled>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:Id>0</d2p1:Id>
<d2p1:MetaData>String</d2p1:MetaData>
<d2p1:Type>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsExtraLicenseOption>false</d2p1:IsExtraLicenseOption>
<d2p1:Items>
<d2p1:LicenseItemsResponse>
<d2p1:AllowedItems>0</d2p1:AllowedItems>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:LicenseItemsResponse>
</d2p1:Items>
<d2p1:Name>String</d2p1:Name>
<d2p1:PeriodOfNoticeDays>0</d2p1:PeriodOfNoticeDays>
<d2p1:Prices xmlns:d5p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d5p1:LicensePrice>
<d5p1:Country>
<d5p1:Culture>String</d5p1:Culture>
<d5p1:CurrencyId>String</d5p1:CurrencyId>
<d5p1:CurrencyInfo>
<d5p1:Active>false</d5p1:Active>
<d5p1:CurrencySign>String</d5p1:CurrencySign>
<d5p1:Id>String</d5p1:Id>
<d5p1:ModifiedDate xmlns:d9p1="http://schemas.datacontract.org/2004/07/System">
<d9p1:DateTime>0001-01-01T00:00:00Z</d9p1:DateTime>
<d9p1:OffsetMinutes>0</d9p1:OffsetMinutes>
</d5p1:ModifiedDate>
<d5p1:Name>String</d5p1:Name>
</d5p1:CurrencyInfo>
<d5p1:Id>String</d5p1:Id>
<d5p1:ModifiedDate xmlns:d8p1="http://schemas.datacontract.org/2004/07/System">
<d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
<d8p1:OffsetMinutes>0</d8p1:OffsetMinutes>
</d5p1:ModifiedDate>
<d5p1:Name>String</d5p1:Name>
<d5p1:TimeZone>String</d5p1:TimeZone>
</d5p1:Country>
<d5p1:CountryId>String</d5p1:CountryId>
<d5p1:LicenseTypeId>0</d5p1:LicenseTypeId>
<d5p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d5p1:ModifiedDate>
<d5p1:Price>0</d5p1:Price>
</d5p1:LicensePrice>
</d2p1:Prices>
</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:CompanyLicenseQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfCompanyLicenseQueryResponseWg5EthtI>