Cochrane+ App API

<back to all web services

ReadAllMessages

Requires Authentication
The following routes are available for this service:
POST/notificationcentre/readall
import Foundation
import ServiceStack

public class ReadAllMessages : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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

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

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

    required public init(){}
}

public class GetNotificationMessageResponse : ApiServiceResponse
{
    public var messages:[NotificationMessageData] = []
    public var unreadCount:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case messages
        case unreadCount
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        messages = try container.decodeIfPresent([NotificationMessageData].self, forKey: .messages) ?? []
        unreadCount = try container.decodeIfPresent(Int.self, forKey: .unreadCount)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if messages.count > 0 { try container.encode(messages, forKey: .messages) }
        if unreadCount != nil { try container.encode(unreadCount, forKey: .unreadCount) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class NotificationMessageData : Codable
{
    public var title:String
    public var content:String
    public var sentBy:String
    public var systemUserMessageId:Int
    public var dateSent:String
    public var comment:String
    public var hasComment:Bool
    public var commentDate:String
    public var hasAttachments:Bool
    public var attachmentList:[NotificationMessageAttachment] = []
    public var hasRead:Bool

    required public init(){}
}

public class NotificationMessageAttachment : Codable
{
    public var isImage:Bool
    public var isPdf:Bool
    public var isWord:Bool
    public var isExcel:Bool
    public var fileName:String
    public var thumbnailUrl:String
    public var fileUrl:String

    required public init(){}
}


Swift ReadAllMessages 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.

POST /notificationcentre/readall HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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