Starlite API

<back to all web services

LockboxDocument

import Foundation
import ServiceStack

public class LockboxDocument : ServiceRequestBase
{
    /**
    * The management company that the member's association belongs to
    */
    // @ApiMember(Description="The management company that the member's association belongs to", IsRequired=true)
    public var managementCompanyId:String?

    /**
    * The association company that the member belongs to
    */
    // @ApiMember(Description="The association company that the member belongs to", IsRequired=true)
    public var associationId:String?

    /**
    * The member ID for whom to retrieve the lockbox document for
    */
    // @ApiMember(Description="The member ID for whom to retrieve the lockbox document for", IsRequired=true)
    public var memberId:String?

    /**
    * The lockbox document ID identifying which document to pull
    */
    // @ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)
    public var documentId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case managementCompanyId
        case associationId
        case memberId
        case documentId
    }

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

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

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

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

<LockboxDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.LockboxDocuments">
  <AssociationId>String</AssociationId>
  <DocumentId>0</DocumentId>
  <ManagementCompanyId>String</ManagementCompanyId>
  <MemberId>String</MemberId>
</LockboxDocument>

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>WAB-WEBPW02</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ApiServiceHostVersion</d2p1:Key>
      <d2p1:Value>1.0.0.0</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ServiceDebugFields>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
</ServiceResponseBase>