| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /messages/dashboard | Search the dashboard messages for any messages. | Search the dashboard messages for any messages. |
|---|
<?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 DasboardMessageTypeResponse implements JsonSerializable
{
public function __construct(
/** @description The message type id */
// @ApiMember(Description="The message type id")
/** @var int */
public int $Id=0,
/** @description The message type name */
// @ApiMember(Description="The message type name")
/** @var string|null */
public ?string $Name=null,
/** @description The message type description */
// @ApiMember(Description="The message type description")
/** @var string|null */
public ?string $Description=null,
/** @description The message type image */
// @ApiMember(Description="The message type image")
/** @var string|null */
public ?string $ImageUrl=null,
/** @description If the message type is a application message */
// @ApiMember(Description="If the message type is a application message")
/** @var bool|null */
public ?bool $ApplicationMessage=null,
/** @description The message type icon */
// @ApiMember(Description="The message type icon")
/** @var string|null */
public ?string $Icon=null,
/** @description The message type color */
// @ApiMember(Description="The message type color")
/** @var string|null */
public ?string $Color=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ImageUrl'])) $this->ImageUrl = $o['ImageUrl'];
if (isset($o['ApplicationMessage'])) $this->ApplicationMessage = $o['ApplicationMessage'];
if (isset($o['Icon'])) $this->Icon = $o['Icon'];
if (isset($o['Color'])) $this->Color = $o['Color'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ImageUrl)) $o['ImageUrl'] = $this->ImageUrl;
if (isset($this->ApplicationMessage)) $o['ApplicationMessage'] = $this->ApplicationMessage;
if (isset($this->Icon)) $o['Icon'] = $this->Icon;
if (isset($this->Color)) $o['Color'] = $this->Color;
return empty($o) ? new class(){} : $o;
}
}
class DashboardMessageQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The message id */
// @ApiMember(Description="The message id")
/** @var int */
public int $Id=0,
/** @description The message title. */
// @ApiMember(Description="The message title.")
/** @var string|null */
public ?string $Title=null,
/** @description The message body. */
// @ApiMember(Description="The message body.")
/** @var string|null */
public ?string $Body=null,
/** @description If the message is important. */
// @ApiMember(Description="If the message is important.")
/** @var bool|null */
public ?bool $Important=null,
/** @description If the message visible from date. */
// @ApiMember(Description="If the message visible from date.")
/** @var DateTime */
public DateTime $VisibleFrom=new DateTime(),
/** @description If the message visible to date. */
// @ApiMember(Description="If the message visible to date.")
/** @var DateTime */
public DateTime $VisibleTo=new DateTime(),
/** @description If the message created date. */
// @ApiMember(Description="If the message created date.")
/** @var DateTime */
public DateTime $Created=new DateTime(),
/** @description If the message type id. */
// @ApiMember(Description="If the message type id.")
/** @var int */
public int $MessageTypeId=0,
/** @description If the message is connected to a support case. */
// @ApiMember(Description="If the message is connected to a support case.")
/** @var int|null */
public ?int $SupportCaseId=null,
/** @description If the message type information. */
// @ApiMember(Description="If the message type information.")
/** @var DasboardMessageTypeResponse|null */
public ?DasboardMessageTypeResponse $MessageType=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Title'])) $this->Title = $o['Title'];
if (isset($o['Body'])) $this->Body = $o['Body'];
if (isset($o['Important'])) $this->Important = $o['Important'];
if (isset($o['VisibleFrom'])) $this->VisibleFrom = JsonConverters::from('DateTime', $o['VisibleFrom']);
if (isset($o['VisibleTo'])) $this->VisibleTo = JsonConverters::from('DateTime', $o['VisibleTo']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
if (isset($o['MessageTypeId'])) $this->MessageTypeId = $o['MessageTypeId'];
if (isset($o['SupportCaseId'])) $this->SupportCaseId = $o['SupportCaseId'];
if (isset($o['MessageType'])) $this->MessageType = JsonConverters::from('DasboardMessageTypeResponse', $o['MessageType']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Title)) $o['Title'] = $this->Title;
if (isset($this->Body)) $o['Body'] = $this->Body;
if (isset($this->Important)) $o['Important'] = $this->Important;
if (isset($this->VisibleFrom)) $o['VisibleFrom'] = JsonConverters::to('DateTime', $this->VisibleFrom);
if (isset($this->VisibleTo)) $o['VisibleTo'] = JsonConverters::to('DateTime', $this->VisibleTo);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
if (isset($this->MessageTypeId)) $o['MessageTypeId'] = $this->MessageTypeId;
if (isset($this->SupportCaseId)) $o['SupportCaseId'] = $this->SupportCaseId;
if (isset($this->MessageType)) $o['MessageType'] = JsonConverters::to('DasboardMessageTypeResponse', $this->MessageType);
return empty($o) ? new class(){} : $o;
}
}
class BaseModel implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
class DashboardMessageType extends BaseModel implements JsonSerializable
{
public function __construct(
// @Required()
/** @var string */
public string $Name='',
// @Required()
/** @var string */
public string $Description='',
// @Required()
/** @var string */
public string $Image='',
/** @var bool|null */
public ?bool $ApplicationMessage=null,
// @Required()
/** @var string */
public string $Color='',
// @Required()
/** @var string */
public string $Icon='',
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Image'])) $this->Image = $o['Image'];
if (isset($o['ApplicationMessage'])) $this->ApplicationMessage = $o['ApplicationMessage'];
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['Icon'])) $this->Icon = $o['Icon'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Image)) $o['Image'] = $this->Image;
if (isset($this->ApplicationMessage)) $o['ApplicationMessage'] = $this->ApplicationMessage;
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->Icon)) $o['Icon'] = $this->Icon;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
class DashboardMessage extends BaseModel implements JsonSerializable
{
public function __construct(
// @References("typeof(BokaMera.API.ServiceModel.Db.DashboardMessageType)")
/** @var int */
public int $MessageTypeId=0,
/** @var DashboardMessageType|null */
public ?DashboardMessageType $MessageType=null,
// @Required()
/** @var string */
public string $CompanyId='',
/** @var int */
public int $Id=0,
// @Required()
/** @var string */
public string $Title='',
// @Required()
/** @var string */
public string $Body='',
// @Required()
/** @var bool|null */
public ?bool $Important=null,
// @Required()
/** @var DateTime */
public DateTime $VisibleFrom=new DateTime(),
// @Required()
/** @var DateTime */
public DateTime $VisibleTo=new DateTime(),
// @Required()
/** @var DateTime */
public DateTime $Created=new DateTime(),
/** @var int|null */
public ?int $SupportCaseId=null,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['MessageTypeId'])) $this->MessageTypeId = $o['MessageTypeId'];
if (isset($o['MessageType'])) $this->MessageType = JsonConverters::from('DashboardMessageType', $o['MessageType']);
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Title'])) $this->Title = $o['Title'];
if (isset($o['Body'])) $this->Body = $o['Body'];
if (isset($o['Important'])) $this->Important = $o['Important'];
if (isset($o['VisibleFrom'])) $this->VisibleFrom = JsonConverters::from('DateTime', $o['VisibleFrom']);
if (isset($o['VisibleTo'])) $this->VisibleTo = JsonConverters::from('DateTime', $o['VisibleTo']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
if (isset($o['SupportCaseId'])) $this->SupportCaseId = $o['SupportCaseId'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->MessageTypeId)) $o['MessageTypeId'] = $this->MessageTypeId;
if (isset($this->MessageType)) $o['MessageType'] = JsonConverters::to('DashboardMessageType', $this->MessageType);
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Title)) $o['Title'] = $this->Title;
if (isset($this->Body)) $o['Body'] = $this->Body;
if (isset($this->Important)) $o['Important'] = $this->Important;
if (isset($this->VisibleFrom)) $o['VisibleFrom'] = JsonConverters::to('DateTime', $this->VisibleFrom);
if (isset($this->VisibleTo)) $o['VisibleTo'] = JsonConverters::to('DateTime', $this->VisibleTo);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
if (isset($this->SupportCaseId)) $o['SupportCaseId'] = $this->SupportCaseId;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
/**
* @template QueryDb2 of DashboardMessage
* @template QueryDb21 of DashboardMessageQueryResponse
*/
class DashboardMessageQuery extends QueryDb2 implements ICompany, 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,
/** @description The company id, if empty will use the company id for the user you are logged in with. */
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")
/** @var string|null */
public ?string $CompanyId=null,
/** @description If you want to filter on important messages only */
// @ApiMember(DataType="boolean", Description="If you want to filter on important messages only", ParameterType="query")
/** @var bool|null */
public ?bool $Important=null,
/** @description Filter on Message Type Id */
// @ApiMember(DataType="int", Description="Filter on Message Type Id", ParameterType="query")
/** @var int|null */
public ?int $MessageTypeId=null,
/** @description If you want to include the message type information */
// @ApiMember(DataType="boolean", Description="If you want to include the message type information", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeMessageTypeInformation=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Important'])) $this->Important = $o['Important'];
if (isset($o['MessageTypeId'])) $this->MessageTypeId = $o['MessageTypeId'];
if (isset($o['IncludeMessageTypeInformation'])) $this->IncludeMessageTypeInformation = $o['IncludeMessageTypeInformation'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Important)) $o['Important'] = $this->Important;
if (isset($this->MessageTypeId)) $o['MessageTypeId'] = $this->MessageTypeId;
if (isset($this->IncludeMessageTypeInformation)) $o['IncludeMessageTypeInformation'] = $this->IncludeMessageTypeInformation;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
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 DashboardMessageQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /messages/dashboard 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,
Title: String,
Body: String,
Important: False,
MessageTypeId: 0,
SupportCaseId: 0,
MessageType:
{
Id: 0,
Name: String,
Description: String,
ImageUrl: String,
ApplicationMessage: False,
Icon: String,
Color: String
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}