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.

**LicensePlanQuery** Parameters:
Name	Parameter	Data Type	Required	Description
Active	query	bool	No	Search active plan.

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**LicensePlan** Parameters:
Name	Parameter	Data Type	Required
VossPlan	form	VossPlanResponse	Yes
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
Active	form	bool	No
CreatedDate	form	DateTime	No

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

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

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

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

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

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

HTTP + XML

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: api-staging.bookmore.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfLicensePlanQueryResponseWg5EthtI 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:LicensePlanQueryResponse>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PlanLength>0</d2p1:PlanLength>
      <d2p1:PlanLengthUnit>Week</d2p1:PlanLengthUnit>
      <d2p1:UpdatedDate>0001-01-01T00:00:00</d2p1:UpdatedDate>
      <d2p1:VossPlan>
        <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
        <d2p1:Length>String</d2p1:Length>
        <d2p1:LengthUnit>String</d2p1:LengthUnit>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:VossPlan>
      <d2p1:VossPlanId>00000000-0000-0000-0000-000000000000</d2p1:VossPlanId>
    </d2p1:LicensePlanQueryResponse>
  </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>
</QueryResponseOfLicensePlanQueryResponseWg5EthtI>