| Requires the role: | superadmin |
| GET | /superadmin/incentives/action | Query incentive actions |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
// @DataContract
class QueryBase implements JsonSerializable
{
public function __construct(
/** @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
// @DataMember(Order=1)
/** @var int|null */
public ?int $Skip=null,
/** @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
// @DataMember(Order=2)
/** @var int|null */
public ?int $Take=null,
/** @description 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.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
// @DataMember(Order=3)
/** @var string|null */
public ?string $OrderBy=null,
/** @description 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.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
// @DataMember(Order=4)
/** @var string|null */
public ?string $OrderByDesc=null,
/** @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
// @DataMember(Order=5)
/** @var string|null */
public ?string $Include=null,
// @DataMember(Order=6)
/** @var string|null */
public ?string $Fields=null,
// @DataMember(Order=7)
/** @var array<string,string>|null */
public ?array $Meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Skip'])) $this->Skip = $o['Skip'];
if (isset($o['Take'])) $this->Take = $o['Take'];
if (isset($o['OrderBy'])) $this->OrderBy = $o['OrderBy'];
if (isset($o['OrderByDesc'])) $this->OrderByDesc = $o['OrderByDesc'];
if (isset($o['Include'])) $this->Include = $o['Include'];
if (isset($o['Fields'])) $this->Fields = $o['Fields'];
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Skip)) $o['Skip'] = $this->Skip;
if (isset($this->Take)) $o['Take'] = $this->Take;
if (isset($this->OrderBy)) $o['OrderBy'] = $this->OrderBy;
if (isset($this->OrderByDesc)) $o['OrderByDesc'] = $this->OrderByDesc;
if (isset($this->Include)) $o['Include'] = $this->Include;
if (isset($this->Fields)) $o['Fields'] = $this->Fields;
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template From
* @template Into
*/
class QueryDb2 extends QueryBase implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryDb2 {
$to = new QueryDb2();
$to->genericArgs = $genericArgs;
return $to;
}
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
mixed $Skip=null,
mixed $Take=null,
mixed $OrderBy=null,
mixed $OrderByDesc=null,
mixed $Include=null,
mixed $Fields=null,
mixed $Meta=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
class BaseModel implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
enum IncentiveActionType : int
{
case Upgrade = 1;
case AddOn = 2;
case Information = 3;
}
class IncentiveAction extends BaseModel implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $Description=null,
/** @var IncentiveActionType|null */
public ?IncentiveActionType $ActionType=null,
/** @var string|null */
public ?string $Page=null,
/** @var string|null */
public ?string $Segment=null,
/** @var string|null */
public ?string $Element=null,
/** @var int|null */
public ?int $LicenseTypeId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ActionType'])) $this->ActionType = JsonConverters::from('IncentiveActionType', $o['ActionType']);
if (isset($o['Page'])) $this->Page = $o['Page'];
if (isset($o['Segment'])) $this->Segment = $o['Segment'];
if (isset($o['Element'])) $this->Element = $o['Element'];
if (isset($o['LicenseTypeId'])) $this->LicenseTypeId = $o['LicenseTypeId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ActionType)) $o['ActionType'] = JsonConverters::to('IncentiveActionType', $this->ActionType);
if (isset($this->Page)) $o['Page'] = $this->Page;
if (isset($this->Segment)) $o['Segment'] = $this->Segment;
if (isset($this->Element)) $o['Element'] = $this->Element;
if (isset($this->LicenseTypeId)) $o['LicenseTypeId'] = $this->LicenseTypeId;
return empty($o) ? new class(){} : $o;
}
}
// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
/**
* @template QueryDb2 of IncentiveAction
* @template QueryDb21 of QueryResponse<IncentiveActionResponse>
*/
class AdminIncentiveActionQuery extends QueryDb2 implements JsonSerializable
{
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
?int $Skip=null,
?int $Take=null,
?string $OrderBy=null,
?string $OrderByDesc=null,
?string $Include=null,
?string $Fields=null,
?array $Meta=null,
/** @var int|null */
public ?int $Id=null,
/** @var string|null */
public ?string $CountryId=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CountryId'])) $this->CountryId = $o['CountryId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CountryId)) $o['CountryId'] = $this->CountryId;
return empty($o) ? new class(){} : $o;
}
}
class AccessKeyTypeResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $KeyType=null,
/** @var string|null */
public ?string $Description=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['KeyType'])) $this->KeyType = $o['KeyType'];
if (isset($o['Description'])) $this->Description = $o['Description'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->KeyType)) $o['KeyType'] = $this->KeyType;
if (isset($this->Description)) $o['Description'] = $this->Description;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
/**
* @template AccessKeyTypeResponse
*/
class QueryResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryResponse {
$to = new QueryResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var int */
public mixed $Offset=0,
// @DataMember(Order=2)
/** @var int */
public mixed $Total=0,
// @DataMember(Order=3)
/** @var array<AccessKeyTypeResponse>|null */
public mixed $Results=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public mixed $Meta=null,
// @DataMember(Order=5)
/** @var ResponseStatus|null */
public mixed $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Offset'])) $this->Offset = $o['Offset'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray($this->genericArgs[0], $o['Results']);
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Offset)) $o['Offset'] = $this->Offset;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray($this->genericArgs[0], $this->Results);
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
PHP AdminIncentiveActionQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/incentives/action HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfQueryResponseOfIncentiveActionResponseWg5EthtI2Lm1MX14 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results>
<QueryResponseOfIncentiveActionResponseWg5EthtI>
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d4p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d4p1:IncentiveActionResponse>
<d4p1:ActionType>Upgrade</d4p1:ActionType>
<d4p1:Description>String</d4p1:Description>
<d4p1:Element>String</d4p1:Element>
<d4p1:Id>0</d4p1:Id>
<d4p1:LicenseTypeId>0</d4p1:LicenseTypeId>
<d4p1:Page>String</d4p1:Page>
<d4p1:Segment>String</d4p1:Segment>
<d4p1:SuggestedLicenseToUpgrade>
<d4p1:Description>String</d4p1:Description>
<d4p1:Id>0</d4p1:Id>
<d4p1:IsExtraLicenseOption>false</d4p1:IsExtraLicenseOption>
<d4p1:Items>
<d4p1:LicenseItemsResponse>
<d4p1:AllowedItems>0</d4p1:AllowedItems>
<d4p1:Id>0</d4p1:Id>
<d4p1:Name>String</d4p1:Name>
</d4p1:LicenseItemsResponse>
</d4p1:Items>
<d4p1:Name>String</d4p1:Name>
<d4p1:PeriodOfNoticeDays>0</d4p1:PeriodOfNoticeDays>
<d4p1:Prices xmlns:d7p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d7p1:LicensePrice>
<d7p1:Country>
<d7p1:Culture>String</d7p1:Culture>
<d7p1:CurrencyId>String</d7p1:CurrencyId>
<d7p1:CurrencyInfo>
<d7p1:Active>false</d7p1:Active>
<d7p1:CurrencySign>String</d7p1:CurrencySign>
<d7p1:Id>String</d7p1:Id>
<d7p1:ModifiedDate xmlns:d11p1="http://schemas.datacontract.org/2004/07/System">
<d11p1:DateTime>0001-01-01T00:00:00Z</d11p1:DateTime>
<d11p1:OffsetMinutes>0</d11p1:OffsetMinutes>
</d7p1:ModifiedDate>
<d7p1:Name>String</d7p1:Name>
</d7p1:CurrencyInfo>
<d7p1:Id>String</d7p1:Id>
<d7p1:ModifiedDate xmlns:d10p1="http://schemas.datacontract.org/2004/07/System">
<d10p1:DateTime>0001-01-01T00:00:00Z</d10p1:DateTime>
<d10p1:OffsetMinutes>0</d10p1:OffsetMinutes>
</d7p1:ModifiedDate>
<d7p1:Name>String</d7p1:Name>
<d7p1:TimeZone>String</d7p1:TimeZone>
</d7p1:Country>
<d7p1:CountryId>String</d7p1:CountryId>
<d7p1:LicenseTypeId>0</d7p1:LicenseTypeId>
<d7p1:ModifiedDate xmlns:d9p1="http://schemas.datacontract.org/2004/07/System">
<d9p1:DateTime>0001-01-01T00:00:00Z</d9p1:DateTime>
<d9p1:OffsetMinutes>0</d9p1:OffsetMinutes>
</d7p1:ModifiedDate>
<d7p1:Price>0</d7p1:Price>
</d7p1:LicensePrice>
</d4p1:Prices>
</d4p1:SuggestedLicenseToUpgrade>
</d4p1:IncentiveActionResponse>
</Results>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<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>
</ResponseStatus>
</QueryResponseOfIncentiveActionResponseWg5EthtI>
</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>
</QueryResponseOfQueryResponseOfIncentiveActionResponseWg5EthtI2Lm1MX14>