Cochrane+ App API

<back to all web services

GetNotificationMessage

Requires Authentication
The following routes are available for this service:
GET/notificationcentre/
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        member val Description:String = null with get,set
        member val Heading:String = null with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val ModelState:Object = null with get,set

    [<AllowNullLiteral>]
    type NotificationMessageAttachment() = 
        member val IsImage:Boolean = new Boolean() with get,set
        member val IsPdf:Boolean = new Boolean() with get,set
        member val IsWord:Boolean = new Boolean() with get,set
        member val IsExcel:Boolean = new Boolean() with get,set
        member val FileName:String = null with get,set
        member val ThumbnailUrl:String = null with get,set
        member val FileUrl:String = null with get,set

    [<AllowNullLiteral>]
    type NotificationMessageData() = 
        member val Title:String = null with get,set
        member val Content:String = null with get,set
        member val SentBy:String = null with get,set
        member val SystemUserMessageId:Int32 = new Int32() with get,set
        member val DateSent:String = null with get,set
        member val Comment:String = null with get,set
        member val HasComment:Boolean = new Boolean() with get,set
        member val CommentDate:String = null with get,set
        member val HasAttachments:Boolean = new Boolean() with get,set
        member val AttachmentList:ResizeArray<NotificationMessageAttachment> = new ResizeArray<NotificationMessageAttachment>() with get,set
        member val HasRead:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetNotificationMessageResponse() = 
        inherit ApiServiceResponse()
        member val Messages:ResizeArray<NotificationMessageData> = new ResizeArray<NotificationMessageData>() with get,set
        member val UnreadCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type GetNotificationMessage() = 
        inherit ApiServiceRequest()
        member val SearchTerm:String = null with get,set
        member val SystemUserMessageId:Int32 = new Int32() with get,set

F# GetNotificationMessage DTOs

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

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