Cochrane+ App API

<back to all web services

GetUnreadMessagesCount

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

public class GetUnreadMessagesCount : 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 GetUnreadMessagesCountResponse : ApiServiceResponse
{
    public var unreadCount:Int

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

    private enum CodingKeys : String, CodingKey {
        case unreadCount
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        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 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(){}
}


Swift GetUnreadMessagesCount DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /notificationcentre/unreadcount HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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