Trendsic Platform Service

<back to all web services

IncomingNotifications

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications
import Foundation
import ServiceStack

public class IncomingNotifications : IncomingNotificationObject
{
    public var apiKey:String

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

    private enum CodingKeys : String, CodingKey {
        case apiKey
    }

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

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

public class IncomingNotificationObject : Codable
{
    public var id:String
    public var customerId:String
    public var message:String
    public var notificationMethod:String
    public var dateReceived:Date

    required public init(){}
}

public class IncomingNotificationsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var incomingNotifications:[IncomingNotificationObject] = []

    required public init(){}
}


Swift IncomingNotifications 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 /v1/IncomingNotifications/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","Message":"String","NotificationMethod":"00000000000000000000000000000000","DateReceived":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"IncomingNotifications":[{"Id":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","Message":"String","NotificationMethod":"00000000000000000000000000000000","DateReceived":"0001-01-01T00:00:00.0000000"}]}