BokaMera.API.Host

LicensePlanQuery

The following routes are available for this service:
GET	/licenses/plans/	Get all license plans	This service is used to get get all license plans that exists.

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

**LicensePlan** Parameters:
Name	Parameter	Data Type	Required
VossPlan	form	VossPlanResponse	No
Id	form	int	Yes
VossPlanId	form	Guid	No
PlanLength	form	int	Yes
PlanLengthUnitId	form	int	Yes
Name	form	string	Yes
Description	form	string	Yes
UpdatedDate	form	DateTime	No
CreatedDate	form	DateTime	No

**VossPlanResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
LengthUnit	form	string	No
Length	form	string	No

**LicensePlanQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
VossPlanId	form	Guid	No
Name	form	string	No
Description	form	string	No
VossPlan	form	VossPlanResponse	No
PlanLength	form	int	No
PlanLengthUnit	form	LengthUnit	No
UpdatedDate	form	DateTime	No
CreatedDate	form	DateTime	No

**LengthUnit** Enum:
Name	Value
Week	1
Month	2
Year	3

**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/plans/ HTTP/1.1 
Host: testapi.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,
			VossPlan: 
			{
				Name: String,
				LengthUnit: String,
				Length: String
			},
			PlanLength: 0,
			PlanLengthUnit: Week
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}