Starlite API

AccountTransactions

The following routes are available for this service:
POST	/Accounts/Transactions
POST	/AccountTransactions

import Foundation
import ServiceStack

// @DataContract
public class AccountTransactions : ServiceRequestBase
{
    /**
    * The property manager ID (or customer code ID) that can manage the account(s) requested
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The property manager ID (or customer code ID) that can manage the account(s) requested")
    public var propertyManagerID:String?

    /**
    * The list of account numbers for which to receive transaction data
    */
    // @DataMember
    // @ApiMember(DataType="List<long>", Description="The list of account numbers for which to receive transaction data")
    public var accountNumbers:[Int] = []

    /**
    * The earliest date (in short DateTime format) for which to find transactions in the specified date range
    */
    // @DataMember
    // @ApiMember(DataType="DateTime", Description="The earliest date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)
    public var fromDate:String?

    /**
    * The most recent date (in short DateTime format) for which to find transactions in the specified date range
    */
    // @DataMember
    // @ApiMember(DataType="DateTime", Description="The most recent date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)
    public var toDate:String?

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

    private enum CodingKeys : String, CodingKey {
        case propertyManagerID
        case accountNumbers
        case fromDate
        case toDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        propertyManagerID = try container.decodeIfPresent(String.self, forKey: .propertyManagerID)
        accountNumbers = try container.decodeIfPresent([Int].self, forKey: .accountNumbers) ?? []
        fromDate = try container.decodeIfPresent(String.self, forKey: .fromDate)
        toDate = try container.decodeIfPresent(String.self, forKey: .toDate)
    }

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

// @DataContract
public class ServiceRequestBase : IHasVersion, Codable
{
    required public init(){}
}

// @DataContract
public class ServiceResponseBase : Codable
{
    /**
    * Identifies whether the request executed successfully, however does not indicated requested data was found
    */
    // @DataMember
    // @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    public var isSuccessful:Bool?

    /**
    * The status code returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status code returned by the service")
    public var statusCode:Int?

    /**
    * The status message returned by the service
    */
    // @DataMember
    // @ApiMember(Description="The status message returned by the service")
    public var statusMessage:String?

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public var serviceDebugFields:[String:String] = [:]

    required public init(){}
}

Swift AccountTransactions 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 /Accounts/Transactions HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PropertyManagerID":"String","AccountNumbers":[0],"FromDate":"String","ToDate":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"WAB-WEBPW02","ApiServiceHostVersion":"1.0.0.0"}}