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.
DashboardMessageQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ImportantquerybooleanNoIf you want to filter on important messages only
MessageTypeIdqueryintNoFilter on Message Type Id
IncludeMessageTypeInformationquerybooleanNoIf you want to include the message type information
ResponseStatusqueryResponseStatusNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip 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
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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
OrderByDescquerystringNoComma 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
IncludequerystringNoInclude 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
FieldsformstringNo
MetaformDictionary<string, string>No
DashboardMessage Parameters:
NameParameterData TypeRequiredDescription
MessageTypeIdformintNo
MessageTypeformDashboardMessageTypeNo
CompanyIdformGuidYes
IdformintNo
TitleformstringYes
BodyformstringYes
ImportantformboolYes
VisibleFromformDateTimeYes
VisibleToformDateTimeYes
CreatedformDateTimeYes
SupportCaseIdformint?No
ModifiedDateformDateTimeOffset?No
DashboardMessageType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ImageformstringYes
ApplicationMessageformbool?No
ColorformstringYes
IconformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
DashboardMessageQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message id
TitleformstringNoThe message title.
BodyformstringNoThe message body.
ImportantformboolNoIf the message is important.
VisibleFromformDateTimeNoIf the message visible from date.
VisibleToformDateTimeNoIf the message visible to date.
CreatedformDateTimeNoIf the message created date.
MessageTypeIdformintNoIf the message type id.
SupportCaseIdformint?NoIf the message is connected to a support case.
MessageTypeformDasboardMessageTypeResponseNoIf the message type information.
DasboardMessageTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message type id
NameformstringNoThe message type name
DescriptionformstringNoThe message type description
ImageUrlformstringNoThe message type image
ApplicationMessageformbool?NoIf the message type is a application message
IconformstringNoThe message type icon
ColorformstringNoThe message type color
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}