GalaxyMobile App API

<back to all web services

NotificationStatus

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

public class NotificationStatus : ApiServiceRequest
{
    public var notificationId:String
    public var timeStamp:String
    public var status:StatusType

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

    private enum CodingKeys : String, CodingKey {
        case notificationId
        case timeStamp
        case status
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        notificationId = try container.decodeIfPresent(String.self, forKey: .notificationId)
        timeStamp = try container.decodeIfPresent(String.self, forKey: .timeStamp)
        status = try container.decodeIfPresent(StatusType.self, forKey: .status)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if notificationId != nil { try container.encode(notificationId, forKey: .notificationId) }
        if timeStamp != nil { try container.encode(timeStamp, forKey: .timeStamp) }
        if status != nil { try container.encode(status, forKey: .status) }
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, IHasClientId, 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(){}
}

// @Flags()
public enum StatusType : Int, Codable
{
    case Received = 0
    case Opened = 1
}

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 NotificationStatus 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.

POST /notification/status HTTP/1.1 
Host: galaxymobile.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"NotificationId":"String","TimeStamp":"String","Status":0,"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}