| 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. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class DashboardMessage
: BaseModel
{
[References(typeof(BokaMera.API.ServiceModel.Db.DashboardMessageType))]
public virtual int MessageTypeId { get; set; }
public virtual DashboardMessageType MessageType { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual string Title { get; set; }
[Required]
public virtual string Body { get; set; }
[Required]
public virtual bool Important { get; set; }
[Required]
public virtual DateTime VisibleFrom { get; set; }
[Required]
public virtual DateTime VisibleTo { get; set; }
[Required]
public virtual DateTime Created { get; set; }
public virtual int? SupportCaseId { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
}
public partial class DashboardMessageType
: BaseModel
{
[Required]
public virtual string Name { get; set; }
[Required]
public virtual string Description { get; set; }
[Required]
public virtual string Image { get; set; }
public virtual bool? ApplicationMessage { get; set; }
[Required]
public virtual string Color { get; set; }
[Required]
public virtual string Icon { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual int Id { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
public partial class DasboardMessageTypeResponse
{
///<summary>
///The message type id
///</summary>
[ApiMember(Description="The message type id")]
public virtual int Id { get; set; }
///<summary>
///The message type name
///</summary>
[ApiMember(Description="The message type name")]
public virtual string Name { get; set; }
///<summary>
///The message type description
///</summary>
[ApiMember(Description="The message type description")]
public virtual string Description { get; set; }
///<summary>
///The message type image
///</summary>
[ApiMember(Description="The message type image")]
public virtual string ImageUrl { get; set; }
///<summary>
///If the message type is a application message
///</summary>
[ApiMember(Description="If the message type is a application message")]
public virtual bool? ApplicationMessage { get; set; }
///<summary>
///The message type icon
///</summary>
[ApiMember(Description="The message type icon")]
public virtual string Icon { get; set; }
///<summary>
///The message type color
///</summary>
[ApiMember(Description="The message type color")]
public virtual string Color { get; set; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class DashboardMessageQuery
: QueryDb<DashboardMessage, DashboardMessageQueryResponse>, ICompany
{
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///If you want to filter on important messages only
///</summary>
[ApiMember(DataType="boolean", Description="If you want to filter on important messages only", ParameterType="query")]
public virtual bool? Important { get; set; }
///<summary>
///Filter on Message Type Id
///</summary>
[ApiMember(DataType="int", Description="Filter on Message Type Id", ParameterType="query")]
public virtual int? MessageTypeId { get; set; }
///<summary>
///If you want to include the message type information
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include the message type information", ParameterType="query")]
public virtual bool IncludeMessageTypeInformation { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class DashboardMessageQueryResponse
{
///<summary>
///The message id
///</summary>
[ApiMember(Description="The message id")]
public virtual int Id { get; set; }
///<summary>
///The message title.
///</summary>
[ApiMember(Description="The message title.")]
public virtual string Title { get; set; }
///<summary>
///The message body.
///</summary>
[ApiMember(Description="The message body.")]
public virtual string Body { get; set; }
///<summary>
///If the message is important.
///</summary>
[ApiMember(Description="If the message is important.")]
public virtual bool Important { get; set; }
///<summary>
///If the message visible from date.
///</summary>
[ApiMember(Description="If the message visible from date.")]
public virtual DateTime VisibleFrom { get; set; }
///<summary>
///If the message visible to date.
///</summary>
[ApiMember(Description="If the message visible to date.")]
public virtual DateTime VisibleTo { get; set; }
///<summary>
///If the message created date.
///</summary>
[ApiMember(Description="If the message created date.")]
public virtual DateTime Created { get; set; }
///<summary>
///If the message type id.
///</summary>
[ApiMember(Description="If the message type id.")]
public virtual int MessageTypeId { get; set; }
///<summary>
///If the message is connected to a support case.
///</summary>
[ApiMember(Description="If the message is connected to a support case.")]
public virtual int? SupportCaseId { get; set; }
///<summary>
///If the message type information.
///</summary>
[ApiMember(Description="If the message type information.")]
public virtual DasboardMessageTypeResponse MessageType { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///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>
///</summary>
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=2)]
public virtual int? Take { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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
}
}
}