BokaMera.API.Host

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/dashboard	Search the dashboard messages for any messages.	Search the dashboard messages for any messages.

**DashboardMessageQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	path	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Important	query	boolean	No	If you want to filter on important messages only
MessageTypeId	query	int	No	Filter on Message Type Id
IncludeMessageTypeInformation	query	boolean	No	If you want to include the message type information
ResponseStatus	query	ResponseStatus	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: `?skip=10&orderBy=Id`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	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. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	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. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include any of the aggregates `AVG, COUNT, FIRST, LAST, MAX, MIN, SUM` in your result set. The results will be returned in the meta field. Example: `?include=COUNT() as Total` or multiple fields with `?include=Count() Total, Min(Age), AVG(Age) AverageAge` or unique with `?include=COUNT(DISTINCT LivingStatus) as UniqueStatus`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**DashboardMessage** Parameters:
Name	Parameter	Data Type	Required
MessageTypeId	form	int	No
MessageType	form	DashboardMessageType	No
CompanyId	form	Guid	Yes
Id	form	int	No
Title	form	string	Yes
Body	form	string	Yes
Important	form	bool	Yes
VisibleFrom	form	DateTime	Yes
VisibleTo	form	DateTime	Yes
Created	form	DateTime	Yes
SupportCaseId	form	int?	No
ModifiedDate	form	DateTimeOffset?	No

**DashboardMessageType** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Description	form	string	Yes
Image	form	string	Yes
ApplicationMessage	form	bool?	No
Color	form	string	Yes
Icon	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

**DashboardMessageQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The message id
Title	form	string	No	The message title.
Body	form	string	No	The message body.
Important	form	bool	No	If the message is important.
VisibleFrom	form	DateTime	No	If the message visible from date.
VisibleTo	form	DateTime	No	If the message visible to date.
Created	form	DateTime	No	If the message created date.
MessageTypeId	form	int	No	If the message type id.
SupportCaseId	form	int?	No	If the message is connected to a support case.
MessageType	form	DasboardMessageTypeResponse	No	If the message type information.

**DasboardMessageTypeResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The message type id
Name	form	string	No	The message type name
Description	form	string	No	The message type description
ImageUrl	form	string	No	The message type image
ApplicationMessage	form	bool?	No	If the message type is a application message
Icon	form	string	No	The message type icon
Color	form	string	No	The message type color

**QueryResponse<AccessKeyTypeResponse>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	No
Description	form	string	No

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>