Starlite API

<back to all web services

LockboxDocument

The following routes are available for this service:
POST/Members/LockboxDocument
import java.math.*
import java.util.*
import net.servicestack.client.*


open 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)
    var ManagementCompanyId:String? = null

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

    /**
    * 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)
    var MemberId:String? = null

    /**
    * The lockbox document ID identifying which document to pull
    */
    @ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)
    var DocumentId:Long? = null
}

@DataContract
open class ServiceRequestBase : IHasVersion
{
}

@DataContract
open class ServiceResponseBase
{
    /**
    * 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")
    var IsSuccessful:Boolean? = null

    /**
    * The status code returned by the service
    */
    @DataMember
    @ApiMember(Description="The status code returned by the service")
    var StatusCode:Int? = null

    /**
    * The status message returned by the service
    */
    @DataMember
    @ApiMember(Description="The status message returned by the service")
    var StatusMessage:String? = null

    @DataMember
    @ApiMember(ExcludeInSchema=true)
    var ServiceDebugFields:HashMap<String,String> = HashMap<String,String>()
}

Kotlin LockboxDocument DTOs

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

HTTP + XML

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

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>