Starlite API

<back to all web services

MemberLockboxTransactions

import Foundation
import ServiceStack

public class MemberLockboxTransactions : ServiceRequestBase
{
    /**
    * The starting date for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The starting date for which to retrieve lockbox document transactions", ParameterType="body")
    public var fromDate:Date?

    /**
    * The ending date for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The ending date for which to retrieve lockbox document transactions", ParameterType="body")
    public var toDate:Date?

    /**
    * The management company id for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The management company id for which to retrieve lockbox document transactions", ParameterType="body")
    public var managementCompanyId:String?

    /**
    * The association for which to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The association for which to retrieve lockbox document transactions", ParameterType="body")
    public var associationId:String?

    /**
    * The individual member for who to retrieve lockbox document transactions
    */
    // @ApiMember(Description="The individual member for who to retrieve lockbox document transactions", ParameterType="body")
    public var memberId:String?

    /**
    * The type of lockbox document for which to retrieve.
    */
    // @ApiMember(Description="The type of lockbox document for which to retrieve.", ParameterType="body")
    public var documentType:String?

    /**
    * The channel which the lockbox document came through.
    */
    // @ApiMember(Description="The channel which the lockbox document came through.", ParameterType="body")
    public var documentChannel:String?

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

    private enum CodingKeys : String, CodingKey {
        case fromDate
        case toDate
        case managementCompanyId
        case associationId
        case memberId
        case documentType
        case documentChannel
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        fromDate = try container.decodeIfPresent(Date.self, forKey: .fromDate)
        toDate = try container.decodeIfPresent(Date.self, forKey: .toDate)
        managementCompanyId = try container.decodeIfPresent(String.self, forKey: .managementCompanyId)
        associationId = try container.decodeIfPresent(String.self, forKey: .associationId)
        memberId = try container.decodeIfPresent(String.self, forKey: .memberId)
        documentType = try container.decodeIfPresent(String.self, forKey: .documentType)
        documentChannel = try container.decodeIfPresent(String.self, forKey: .documentChannel)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if fromDate != nil { try container.encode(fromDate, forKey: .fromDate) }
        if toDate != nil { try container.encode(toDate, forKey: .toDate) }
        if managementCompanyId != nil { try container.encode(managementCompanyId, forKey: .managementCompanyId) }
        if associationId != nil { try container.encode(associationId, forKey: .associationId) }
        if memberId != nil { try container.encode(memberId, forKey: .memberId) }
        if documentType != nil { try container.encode(documentType, forKey: .documentType) }
        if documentChannel != nil { try container.encode(documentChannel, forKey: .documentChannel) }
    }
}

// @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 MemberLockboxTransactions DTOs

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

<MemberLockboxTransactions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.LockboxDocuments">
  <AssociationId>String</AssociationId>
  <DocumentChannel>String</DocumentChannel>
  <DocumentType>String</DocumentType>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ManagementCompanyId>String</ManagementCompanyId>
  <MemberId>String</MemberId>
  <ToDate>0001-01-01T00:00:00</ToDate>
</MemberLockboxTransactions>

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>