| 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. |
|---|
// @DataContract
export class QueryBase
{
/** @description 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)
public Skip?: number;
/** @description 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)
public Take?: number;
/** @description 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)
public OrderBy: string;
/** @description 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)
public OrderByDesc: string;
/** @description 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)
public Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class DasboardMessageTypeResponse
{
/** @description The message type id */
// @ApiMember(Description="The message type id")
public Id: number;
/** @description The message type name */
// @ApiMember(Description="The message type name")
public Name: string;
/** @description The message type description */
// @ApiMember(Description="The message type description")
public Description: string;
/** @description The message type image */
// @ApiMember(Description="The message type image")
public ImageUrl: string;
/** @description If the message type is a application message */
// @ApiMember(Description="If the message type is a application message")
public ApplicationMessage?: boolean;
/** @description The message type icon */
// @ApiMember(Description="The message type icon")
public Icon: string;
/** @description The message type color */
// @ApiMember(Description="The message type color")
public Color: string;
public constructor(init?: Partial<DasboardMessageTypeResponse>) { (Object as any).assign(this, init); }
}
export class DashboardMessageQueryResponse
{
/** @description The message id */
// @ApiMember(Description="The message id")
public Id: number;
/** @description The message title. */
// @ApiMember(Description="The message title.")
public Title: string;
/** @description The message body. */
// @ApiMember(Description="The message body.")
public Body: string;
/** @description If the message is important. */
// @ApiMember(Description="If the message is important.")
public Important: boolean;
/** @description If the message visible from date. */
// @ApiMember(Description="If the message visible from date.")
public VisibleFrom: string;
/** @description If the message visible to date. */
// @ApiMember(Description="If the message visible to date.")
public VisibleTo: string;
/** @description If the message created date. */
// @ApiMember(Description="If the message created date.")
public Created: string;
/** @description If the message type id. */
// @ApiMember(Description="If the message type id.")
public MessageTypeId: number;
/** @description If the message is connected to a support case. */
// @ApiMember(Description="If the message is connected to a support case.")
public SupportCaseId?: number;
/** @description If the message type information. */
// @ApiMember(Description="If the message type information.")
public MessageType: DasboardMessageTypeResponse;
public constructor(init?: Partial<DashboardMessageQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class DashboardMessageType extends BaseModel
{
// @Required()
public Name: string;
// @Required()
public Description: string;
// @Required()
public Image: string;
public ApplicationMessage?: boolean;
// @Required()
public Color: string;
// @Required()
public Icon: string;
public ModifiedDate?: string;
public Id: number;
public constructor(init?: Partial<DashboardMessageType>) { super(init); (Object as any).assign(this, init); }
}
export class DashboardMessage extends BaseModel
{
// @References("typeof(BokaMera.API.ServiceModel.Db.DashboardMessageType)")
public MessageTypeId: number;
public MessageType: DashboardMessageType;
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public Title: string;
// @Required()
public Body: string;
// @Required()
public Important: boolean;
// @Required()
public VisibleFrom: string;
// @Required()
public VisibleTo: string;
// @Required()
public Created: string;
public SupportCaseId?: number;
public ModifiedDate?: string;
public constructor(init?: Partial<DashboardMessage>) { super(init); (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class DashboardMessageQuery extends QueryDb<DashboardMessage, DashboardMessageQueryResponse> implements ICompany
{
/** @description 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")
public CompanyId?: string;
/** @description If you want to filter on important messages only */
// @ApiMember(DataType="boolean", Description="If you want to filter on important messages only", ParameterType="query")
public Important?: boolean;
/** @description Filter on Message Type Id */
// @ApiMember(DataType="int", Description="Filter on Message Type Id", ParameterType="query")
public MessageTypeId?: number;
/** @description If you want to include the message type information */
// @ApiMember(DataType="boolean", Description="If you want to include the message type information", ParameterType="query")
public IncludeMessageTypeInformation: boolean;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DashboardMessageQuery>) { super(init); (Object as any).assign(this, init); }
}
export class AccessKeyTypeResponse
{
public Id: number;
public KeyType: string;
public Description: string;
public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: AccessKeyTypeResponse[];
// @DataMember(Order=4)
public Meta: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
TypeScript DashboardMessageQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}