BokaMera.API.Host

<back to all web services

LicenseTypeQuery

The following routes are available for this service:
GET/licenses/types/Get all license typesThis service is used to get get all license types that exists.
LicenseTypeQuery Parameters:
NameParameterData TypeRequiredDescription
ExtraLicenseOptionquerybooleanNoIf you want to only select Extra license options
CountryIdquerystringYesWhat country you want to list the prices for
IncludeLicenseItemsquerybooleanNoIf you want to include the connected license items
IncludeLicensePricesquerybooleanNoIf you want to include the connected license prices
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
LicenseTypes Parameters:
NameParameterData TypeRequiredDescription
LicenseItemsformIList<LicenseTypeItem>Yes
PricesformIList<LicensePrice>Yes
IsFreeformboolNo
PeriodOfNoticeDaysformintNo
NextLicenseOptionformLicenseTypesYes
NameformstringYes
DescriptionformstringYes
ExtraLicenseOptionformboolYes
ModifiedDateformDateTimeOffset?No
ActiveformboolNo
VossTierIdformGuidNo
IdformintNo
LicenseTypeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
LicenseTypeformLicenseTypesYes
LicenseTypesIdformintYes
LicenseItemsIdformintYes
NumberOfItemsformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
LicensePrice Parameters:
NameParameterData TypeRequiredDescription
CountryformCountryYes
LicenseTypeIdformintYes
CountryIdformstringYes
PriceformintYes
ModifiedDateformDateTimeOffset?No
LicensePlanIdformintNo
Country Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringYes
CurrencyInfoformCurrencyYes
NameformstringYes
CultureformstringNo
TimeZoneformstringNo
ModifiedDateformDateTimeOffset?No
IdformstringYes
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CurrencySignformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformstringYes
LicenseInformationQueryResponse Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
UrlformUriYes
FreeEditionformboolNo
StartEditionformboolNo
ProEditionformboolNo
SmartEditionformboolNo
EnterpriseEditionformboolNo
FreeEditionValueformstringYes
StartEditionValueformstringYes
ProEditionValueformstringYes
SmartEditionValueformstringYes
EnterpriseEditionValueformstringYes
LicenseInformationTypeIdformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Name":"String","Description":"String","FreeEdition":false,"StartEdition":false,"ProEdition":false,"SmartEdition":false,"EnterpriseEdition":false,"FreeEditionValue":"String","StartEditionValue":"String","ProEditionValue":"String","SmartEditionValue":"String","EnterpriseEditionValue":"String","LicenseInformationTypeId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}