| POST | /notificationcentre/readall |
|---|
"use strict";
export class ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
apiKey;
/**
* @type {number}
* @description Latitude of the user making this request */
latitude;
/**
* @type {number}
* @description Longitude of the user making this request */
longitude;
}
export class ApiServiceResponse {
/** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
description;
/** @type {string} */
heading;
/** @type {boolean} */
wasSuccessful;
/** @type {Object} */
modelState;
}
export class NotificationMessageAttachment {
/** @param {{isImage?:boolean,isPdf?:boolean,isWord?:boolean,isExcel?:boolean,fileName?:string,thumbnailUrl?:string,fileUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
isImage;
/** @type {boolean} */
isPdf;
/** @type {boolean} */
isWord;
/** @type {boolean} */
isExcel;
/** @type {string} */
fileName;
/** @type {string} */
thumbnailUrl;
/** @type {string} */
fileUrl;
}
export class NotificationMessageData {
/** @param {{title?:string,content?:string,sentBy?:string,systemUserMessageId?:number,dateSent?:string,comment?:string,hasComment?:boolean,commentDate?:string,hasAttachments?:boolean,attachmentList?:NotificationMessageAttachment[],hasRead?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
title;
/** @type {string} */
content;
/** @type {string} */
sentBy;
/** @type {number} */
systemUserMessageId;
/** @type {string} */
dateSent;
/** @type {string} */
comment;
/** @type {boolean} */
hasComment;
/** @type {string} */
commentDate;
/** @type {boolean} */
hasAttachments;
/** @type {NotificationMessageAttachment[]} */
attachmentList;
/** @type {boolean} */
hasRead;
}
export class GetNotificationMessageResponse extends ApiServiceResponse {
/** @param {{messages?:NotificationMessageData[],unreadCount?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {NotificationMessageData[]} */
messages;
/** @type {number} */
unreadCount;
}
export class ReadAllMessages extends ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript ReadAllMessages DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /notificationcentre/readall HTTP/1.1
Host: cochraneplus-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
messages:
[
{
}
],
unreadCount: 0,
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}