BokaMera.API.Host

LicenseInformationQuery

The following routes are available for this service:
GET	/licenses/information/	Get whats included in each license	This service is used to get to summare of information about whats included in each license.

**LicenseInformationQuery** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeLicensePrices	query	boolean	No	If you want to include the connected license prices
ResponseStatus	query	ResponseStatus	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: `?skip=10&orderBy=Id`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	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. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	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. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include any of the aggregates `AVG, COUNT, FIRST, LAST, MAX, MIN, SUM` in your result set. The results will be returned in the meta field. Example: `?include=COUNT() as Total` or multiple fields with `?include=Count() Total, Min(Age), AVG(Age) AverageAge` or unique with `?include=COUNT(DISTINCT LivingStatus) as UniqueStatus`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**LicenseInformation** Parameters:
Name	Parameter	Data Type	Required
Prices	form	IList<LicensePrice>	No
Id	form	int	No
LicenseInformationId	form	int	No
Name	form	string	Yes
Description	form	string	Yes
Url	form	string	No
FreeEdition	form	bool	Yes
FreeEditionValue	form	string	No
StartEdition	form	bool	Yes
StartEditionValue	form	string	No
SmartEdition	form	bool?	No
SmartEditionValue	form	string	No
ProEdition	form	bool	Yes
ProEditionValue	form	string	No
EnterpriseEdition	form	bool?	No
EnterpriseEditionValue	form	string	No
ModifiedDate	form	DateTimeOffset?	No

**LicensePrice** Parameters:
Name	Parameter	Data Type	Required
Country	form	Country	No
MonthlyPayment	form	bool	No
LicenseTypeId	form	int	Yes
CountryId	form	string	Yes
Price	form	int	Yes
ModifiedDate	form	DateTimeOffset?	No

**Country** Parameters:
Name	Parameter	Data Type	Required
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

**Currency** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
CurrencySign	form	string	Yes
Active	form	bool	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

**LicenseTypeQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The license type id
Name	form	string	No	The license type name
Description	form	string	No	The license type description
IsExtraLicenseOption	form	bool	No	If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
PeriodOfNoticeDays	form	int	No	The period of notice for the license in days.
Items	form	List<LicenseItemsResponse>	No	The license items for the license type
Prices	form	List<LicensePrice>	No	The license prices in each country for the license type

**LicenseItemsResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
AllowedItems	form	int	No

**QueryResponse<AccessKeyTypeResponse>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	No
Description	form	string	No

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /licenses/information/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			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
				}
			]
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}