GET | /licenses/types/ | Get all license types | This service is used to get get all license types that exists. |
---|
// @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 LicenseInformationQueryResponse
{
public Name: string;
public Description: string;
public Url: string;
public FreeEdition: boolean;
public StartEdition: boolean;
public ProEdition: boolean;
public SmartEdition: boolean;
public EnterpriseEdition: boolean;
public FreeEditionValue: string;
public StartEditionValue: string;
public ProEditionValue: string;
public SmartEditionValue: string;
public EnterpriseEditionValue: string;
public LicenseInformationTypeId: number;
public constructor(init?: Partial<LicenseInformationQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (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 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 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); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class LicenseTypeQuery extends QueryDb<LicenseType, LicenseInformationQueryResponse>
{
/** @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 ExtraLicenseOption?: 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 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 Active: boolean;
public constructor(init?: Partial<LicenseTypeQuery>) { 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 LicenseTypeQuery 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 /licenses/types/ HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfLicenseInformationQueryResponseWg5EthtI 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:LicenseInformationQueryResponse> <d2p1:Description>String</d2p1:Description> <d2p1:EnterpriseEdition>false</d2p1:EnterpriseEdition> <d2p1:EnterpriseEditionValue>String</d2p1:EnterpriseEditionValue> <d2p1:FreeEdition>false</d2p1:FreeEdition> <d2p1:FreeEditionValue>String</d2p1:FreeEditionValue> <d2p1:LicenseInformationTypeId>0</d2p1:LicenseInformationTypeId> <d2p1:Name>String</d2p1:Name> <d2p1:ProEdition>false</d2p1:ProEdition> <d2p1:ProEditionValue>String</d2p1:ProEditionValue> <d2p1:SmartEdition>false</d2p1:SmartEdition> <d2p1:SmartEditionValue>String</d2p1:SmartEditionValue> <d2p1:StartEdition>false</d2p1:StartEdition> <d2p1:StartEditionValue>String</d2p1:StartEditionValue> <d2p1:Url i:nil="true" /> </d2p1:LicenseInformationQueryResponse> </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> </QueryResponseOfLicenseInformationQueryResponseWg5EthtI>