Starlite API

<back to all web services

BankStatements

The following routes are available for this service:
POST/Statements/BankStatements
import Foundation
import ServiceStack

public class BankStatements : ServiceRequestBase
{
    /**
    * The account number for the requested statement.
    */
    // @ApiMember(Description="The account number for the requested statement.", IsRequired=true)
    public var accountNumber:Int?

    /**
    * The short-date format (mm-dd-yyyy) of the statement date.
    */
    // @ApiMember(Description="The short-date format (mm-dd-yyyy) of the statement date.", IsRequired=true)
    public var statementDate:Date?

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

    private enum CodingKeys : String, CodingKey {
        case accountNumber
        case statementDate
    }

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

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

// @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 BankStatements 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 /Statements/BankStatements HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AccountNumber":0,"StatementDate":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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