BokaMera.API.Host

<back to all web services

DashboardMessageQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/messages/dashboardSearch the dashboard messages for any messages.Search the dashboard messages for any messages.
namespace BokaMera.API.ServiceModel.Db

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DasboardMessageTypeResponse() = 
        ///<summary>
        ///The message type id
        ///</summary>
        [<ApiMember(Description="The message type id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The message type name
        ///</summary>
        [<ApiMember(Description="The message type name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The message type description
        ///</summary>
        [<ApiMember(Description="The message type description")>]
        member val Description:String = null with get,set

        ///<summary>
        ///The message type image
        ///</summary>
        [<ApiMember(Description="The message type image")>]
        member val ImageUrl:String = null with get,set

        ///<summary>
        ///If the message type is a application message
        ///</summary>
        [<ApiMember(Description="If the message type is a application message")>]
        member val ApplicationMessage:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///The message type icon
        ///</summary>
        [<ApiMember(Description="The message type icon")>]
        member val Icon:String = null with get,set

        ///<summary>
        ///The message type color
        ///</summary>
        [<ApiMember(Description="The message type color")>]
        member val Color:String = null with get,set

    [<AllowNullLiteral>]
    type DashboardMessageQueryResponse() = 
        ///<summary>
        ///The message id
        ///</summary>
        [<ApiMember(Description="The message id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The message title.
        ///</summary>
        [<ApiMember(Description="The message title.")>]
        member val Title:String = null with get,set

        ///<summary>
        ///The message body.
        ///</summary>
        [<ApiMember(Description="The message body.")>]
        member val Body:String = null with get,set

        ///<summary>
        ///If the message is important.
        ///</summary>
        [<ApiMember(Description="If the message is important.")>]
        member val Important:Boolean = new Boolean() with get,set

        ///<summary>
        ///If the message visible from date.
        ///</summary>
        [<ApiMember(Description="If the message visible from date.")>]
        member val VisibleFrom:DateTime = new DateTime() with get,set

        ///<summary>
        ///If the message visible to date.
        ///</summary>
        [<ApiMember(Description="If the message visible to date.")>]
        member val VisibleTo:DateTime = new DateTime() with get,set

        ///<summary>
        ///If the message created date.
        ///</summary>
        [<ApiMember(Description="If the message created date.")>]
        member val Created:DateTime = new DateTime() with get,set

        ///<summary>
        ///If the message type id.
        ///</summary>
        [<ApiMember(Description="If the message type id.")>]
        member val MessageTypeId:Int32 = new Int32() with get,set

        ///<summary>
        ///If the message is connected to a support case.
        ///</summary>
        [<ApiMember(Description="If the message is connected to a support case.")>]
        member val SupportCaseId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///If the message type information.
        ///</summary>
        [<ApiMember(Description="If the message type information.")>]
        member val MessageType:DasboardMessageTypeResponse = null with get,set

    [<AllowNullLiteral>]
    type BaseModel() = 
        class end

    [<AllowNullLiteral>]
    type DashboardMessageType() = 
        inherit BaseModel()
        [<Required>]
        member val Name:String = null with get,set

        [<Required>]
        member val Description:String = null with get,set

        [<Required>]
        member val Image:String = null with get,set

        member val ApplicationMessage:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        [<Required>]
        member val Color:String = null with get,set

        [<Required>]
        member val Icon:String = null with get,set

        member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val Id:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DashboardMessage() = 
        inherit BaseModel()
        [<References(typeof<DashboardMessageType>)>]
        member val MessageTypeId:Int32 = new Int32() with get,set

        member val MessageType:DashboardMessageType = null with get,set
        [<Required>]
        member val CompanyId:Guid = new Guid() with get,set

        member val Id:Int32 = new Int32() with get,set
        [<Required>]
        member val Title:String = null with get,set

        [<Required>]
        member val Body:String = null with get,set

        [<Required>]
        member val Important:Boolean = new Boolean() with get,set

        [<Required>]
        member val VisibleFrom:DateTime = new DateTime() with get,set

        [<Required>]
        member val VisibleTo:DateTime = new DateTime() with get,set

        [<Required>]
        member val Created:DateTime = new DateTime() with get,set

        member val SupportCaseId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type DashboardMessageQuery() = 
        inherit QueryDb<DashboardMessage, DashboardMessageQueryResponse>()
        ///<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with 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")>]
        member val Important:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///Filter on Message Type Id
        ///</summary>
        [<ApiMember(DataType="int", Description="Filter on Message Type Id", ParameterType="query")>]
        member val MessageTypeId:Nullable<Int32> = new Nullable<Int32>() with 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")>]
        member val IncludeMessageTypeInformation:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        ///<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)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with 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)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with 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)>]
        member val OrderBy:String = null with 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)>]
        member val OrderByDesc:String = null with 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)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<From, Into>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type AccessKeyTypeResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val KeyType:String = null with get,set
        member val Description:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<AccessKeyTypeResponse>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# DashboardMessageQuery DTOs

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 /messages/dashboard HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfDashboardMessageQueryResponseWg5EthtI 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:DashboardMessageQueryResponse>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Important>false</d2p1:Important>
      <d2p1:MessageType>
        <d2p1:ApplicationMessage>false</d2p1:ApplicationMessage>
        <d2p1:Color>String</d2p1:Color>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Icon>String</d2p1:Icon>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:ImageUrl>String</d2p1:ImageUrl>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:MessageType>
      <d2p1:MessageTypeId>0</d2p1:MessageTypeId>
      <d2p1:SupportCaseId>0</d2p1:SupportCaseId>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:VisibleFrom>0001-01-01T00:00:00</d2p1:VisibleFrom>
      <d2p1:VisibleTo>0001-01-01T00:00:00</d2p1:VisibleTo>
    </d2p1:DashboardMessageQueryResponse>
  </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>
</QueryResponseOfDashboardMessageQueryResponseWg5EthtI>