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.
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class DashboardMessageQuery : QueryDb<DashboardMessage, DashboardMessageQueryResponse>(), ICompany
{
    /**
    * 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 CompanyId:UUID? = null

    /**
    * 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 Important:Boolean? = null

    /**
    * Filter on Message Type Id
    */
    @ApiMember(DataType="int", Description="Filter on Message Type Id", ParameterType="query")
    var MessageTypeId:Int? = null

    /**
    * 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 IncludeMessageTypeInformation:Boolean? = null

    var ResponseStatus:ResponseStatus? = null
}

open class QueryDb<From, Into> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    /**
    * 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 Skip:Int? = null

    /**
    * 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 Take:Int? = null

    /**
    * 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 OrderBy:String? = null

    /**
    * 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 OrderByDesc:String? = null

    /**
    * 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 Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class DashboardMessage : BaseModel()
{
    @References(DashboardMessageType.class)
    var MessageTypeId:Int? = null

    var MessageType:DashboardMessageType? = null
    @Required()
    var CompanyId:UUID? = null

    var Id:Int? = null
    @Required()
    var Title:String? = null

    @Required()
    var Body:String? = null

    @Required()
    var Important:Boolean? = null

    @Required()
    var VisibleFrom:Date? = null

    @Required()
    var VisibleTo:Date? = null

    @Required()
    var Created:Date? = null

    var SupportCaseId:Int? = null
    var ModifiedDate:Date? = null
}

open class BaseModel
{
}

open class DashboardMessageType : BaseModel()
{
    @Required()
    var Name:String? = null

    @Required()
    var Description:String? = null

    @Required()
    var Image:String? = null

    var ApplicationMessage:Boolean? = null
    @Required()
    var Color:String? = null

    @Required()
    var Icon:String? = null

    var ModifiedDate:Date? = null
    var Id:Int? = null
}

open class DashboardMessageQueryResponse
{
    /**
    * The message id
    */
    @ApiMember(Description="The message id")
    var Id:Int? = null

    /**
    * The message title.
    */
    @ApiMember(Description="The message title.")
    var Title:String? = null

    /**
    * The message body.
    */
    @ApiMember(Description="The message body.")
    var Body:String? = null

    /**
    * If the message is important.
    */
    @ApiMember(Description="If the message is important.")
    var Important:Boolean? = null

    /**
    * If the message visible from date.
    */
    @ApiMember(Description="If the message visible from date.")
    var VisibleFrom:Date? = null

    /**
    * If the message visible to date.
    */
    @ApiMember(Description="If the message visible to date.")
    var VisibleTo:Date? = null

    /**
    * If the message created date.
    */
    @ApiMember(Description="If the message created date.")
    var Created:Date? = null

    /**
    * If the message type id.
    */
    @ApiMember(Description="If the message type id.")
    var MessageTypeId:Int? = null

    /**
    * If the message is connected to a support case.
    */
    @ApiMember(Description="If the message is connected to a support case.")
    var SupportCaseId:Int? = null

    /**
    * If the message type information.
    */
    @ApiMember(Description="If the message type information.")
    var MessageType:DasboardMessageTypeResponse? = null
}

open class DasboardMessageTypeResponse
{
    /**
    * The message type id
    */
    @ApiMember(Description="The message type id")
    var Id:Int? = null

    /**
    * The message type name
    */
    @ApiMember(Description="The message type name")
    var Name:String? = null

    /**
    * The message type description
    */
    @ApiMember(Description="The message type description")
    var Description:String? = null

    /**
    * The message type image
    */
    @ApiMember(Description="The message type image")
    var ImageUrl:String? = null

    /**
    * If the message type is a application message
    */
    @ApiMember(Description="If the message type is a application message")
    var ApplicationMessage:Boolean? = null

    /**
    * The message type icon
    */
    @ApiMember(Description="The message type icon")
    var Icon:String? = null

    /**
    * The message type color
    */
    @ApiMember(Description="The message type color")
    var Color:String? = null
}

@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    var Id:Int? = null
    var KeyType:String? = null
    var Description:String? = null
}

Kotlin DashboardMessageQuery DTOs

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

HTTP + 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
		}
	}
}