Cochrane+ App API

ReadAllMessages

The following routes are available for this service:
POST	/notificationcentre/readall

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports CommonService.Api.Models.Base

Namespace Global

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class
    End Namespace

    Namespace WebService.ServiceModel

        Public Partial Class GetNotificationMessageResponse
            Inherits ApiServiceResponse
            Public Sub New()
                Messages = New List(Of NotificationMessageData)
            End Sub

            Public Overridable Property Messages As List(Of NotificationMessageData)
            Public Overridable Property UnreadCount As Integer
        End Class

        Public Partial Class NotificationMessageAttachment
            Public Overridable Property IsImage As Boolean
            Public Overridable Property IsPdf As Boolean
            Public Overridable Property IsWord As Boolean
            Public Overridable Property IsExcel As Boolean
            Public Overridable Property FileName As String
            Public Overridable Property ThumbnailUrl As String
            Public Overridable Property FileUrl As String
        End Class

        Public Partial Class NotificationMessageData
            Public Sub New()
                AttachmentList = New List(Of NotificationMessageAttachment)
            End Sub

            Public Overridable Property Title As String
            Public Overridable Property Content As String
            Public Overridable Property SentBy As String
            Public Overridable Property SystemUserMessageId As Integer
            Public Overridable Property DateSent As String
            Public Overridable Property Comment As String
            Public Overridable Property HasComment As Boolean
            Public Overridable Property CommentDate As String
            Public Overridable Property HasAttachments As Boolean
            Public Overridable Property AttachmentList As List(Of NotificationMessageAttachment)
            Public Overridable Property HasRead As Boolean
        End Class

        Public Partial Class ReadAllMessages
            Inherits ApiServiceRequest
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

VB.NET ReadAllMessages DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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