Starlite API

<back to all web services

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

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

<TransactionList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.AccountTransactions">
  <_x003C_AccountID_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_x003C_AccountID_x003E_k__BackingField>
  <_x003C_CustomerCode_x003E_k__BackingField>String</_x003C_CustomerCode_x003E_k__BackingField>
  <_x003C_FromDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_FromDate_x003E_k__BackingField>
  <_x003C_ToDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ToDate_x003E_k__BackingField>
</TransactionList>

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

<ServiceResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiContext">
  <IsSuccessful>false</IsSuccessful>
  <ServiceDebugFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHost</d2p1:Key>
      <d2p1:Value>AZW-AABWPW03</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHostVersion</d2p1:Key>
      <d2p1:Value>2016.1.18.3</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ServiceDebugFields>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
</ServiceResponseBase>