Cochrane+ App API

<back to all web services

GetNotificationMessage

Requires Authentication
The following routes are available for this service:
GET/notificationcentre/
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetNotificationMessage : ApiServiceRequest()
{
    var searchTerm:String? = null
    var systemUserMessageId:Int? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class GetNotificationMessageResponse : ApiServiceResponse()
{
    var messages:ArrayList<NotificationMessageData> = ArrayList<NotificationMessageData>()
    var unreadCount:Int? = null
}

open class ApiServiceResponse : IServiceResponse
{
    var description:String? = null
    var heading:String? = null
    var wasSuccessful:Boolean? = null
    var modelState:Object? = null
}

open class NotificationMessageData
{
    var title:String? = null
    var content:String? = null
    var sentBy:String? = null
    var systemUserMessageId:Int? = null
    var dateSent:String? = null
    var comment:String? = null
    var hasComment:Boolean? = null
    var commentDate:String? = null
    var hasAttachments:Boolean? = null
    var attachmentList:ArrayList<NotificationMessageAttachment> = ArrayList<NotificationMessageAttachment>()
    var hasRead:Boolean? = null
}

open class NotificationMessageAttachment
{
    var isImage:Boolean? = null
    var isPdf:Boolean? = null
    var isWord:Boolean? = null
    var isExcel:Boolean? = null
    var fileName:String? = null
    var thumbnailUrl:String? = null
    var fileUrl:String? = null
}

Kotlin GetNotificationMessage 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 /notificationcentre/ HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	messages: 
	[
		{
			
		}
	],
	unreadCount: 0,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}