BokaMera.API.Host

SuperAdminCompanyLicenseQuery

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
GET	/superadmin/licenses/company	Find licenses for the logged in users company	Find licenses for the logged in users company.

**SuperAdminCompanyLicenseQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
OnlyActiveLicenses	query	boolean	No	If you want to include the connected license items
CountryId	query	string	No	What country you want to list the prices for
MetaData	query	string	No	Search by the Meta data information on the license
TypeId	query	int?	No	Id of the license type
IsExtraLicenseOption	query	boolean	No	If you want to only select Extra license options
IncludeLicenseItems	query	boolean	No	If you want to include the connected license items
IncludeLicensePrices	query	boolean	No	If you want to include the connected licens 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

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

**LicenseType** Parameters:
Name	Parameter	Data Type	Required
LicenseItems	form	IList<LicenseTypeItem>	No
Prices	form	IList<LicensePrice>	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

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

**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

**CompanyLicenseQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TypeId	form	int	No
Type	form	LicenseTypeQueryResponse	No
ValidFrom	form	DateTime	No
ValidTo	form	DateTime	No
MetaData	form	string	No
Active	form	bool	No
Canceled	form	bool	No
Updated	form	DateTime	No
Created	form	DateTime	No

**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 /superadmin/licenses/company 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,
			TypeId: 0,
			Type: 
			{
				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
					}
				]
			},
			MetaData: String,
			Active: False,
			Canceled: False
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}