Starlite API

<back to all web services

TransactionList

The following routes are available for this service:
POST/Accounts/TransactionsList
POST/TransactionList/
import Foundation
import ServiceStack

public class TransactionList : ServiceRequestBase
{
    /**
    * Customer Code Description
    */
    // @DataMember
    // @ApiMember(DataType="String", Description="Customer Code Description", IsRequired=true, Name="CustomerCode", ParameterType="form")
    public var customerCode:String?

    /**
    * Account ID Description
    */
    // @DataMember
    // @ApiMember(DataType="List<String>", Description="Account ID Description", IsRequired=true, Name="AccountID", ParameterType="form")
    public var accountID:[String] = []

    /**
    * From Date Description
    */
    // @DataMember
    // @ApiMember(DataType="DateTime", Description="From Date Description", IsRequired=true, Name="FromDate", ParameterType="form")
    public var fromDate:Date?

    /**
    * To Date Description
    */
    // @DataMember
    // @ApiMember(DataType="DateTime", Description="To Date Description", IsRequired=true, Name="ToDate", ParameterType="form")
    public var toDate:Date?

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

    private enum CodingKeys : String, CodingKey {
        case customerCode
        case accountID
        case fromDate
        case toDate
    }

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

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if customerCode != nil { try container.encode(customerCode, forKey: .customerCode) }
        if accountID.count > 0 { try container.encode(accountID, forKey: .accountID) }
        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 TransactionList DTOs

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

HTTP + JSV

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

POST /Accounts/TransactionsList HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustomerCode: String,
	AccountID: 
	[
		String
	],
	FromDate: 0001-01-01,
	ToDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsSuccessful: False,
	StatusCode: 0,
	StatusMessage: String,
	ServiceDebugFields: 
	{
		ApiServiceHost: AZW-AABWPW03,
		ApiServiceHostVersion: 2016.1.18.3
	}
}