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.*;

public class dtos
{

    public static class LockboxDocument extends 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 String ManagementCompanyId = null;

        /**
        * The association company that the member belongs to
        */
        @ApiMember(Description="The association company that the member belongs to", IsRequired=true)
        public String AssociationId = 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)
        public String MemberId = null;

        /**
        * The lockbox document ID identifying which document to pull
        */
        @ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)
        public Long DocumentId = null;
        
        public String getManagementCompanyId() { return ManagementCompanyId; }
        public LockboxDocument setManagementCompanyId(String value) { this.ManagementCompanyId = value; return this; }
        public String getAssociationId() { return AssociationId; }
        public LockboxDocument setAssociationId(String value) { this.AssociationId = value; return this; }
        public String getMemberId() { return MemberId; }
        public LockboxDocument setMemberId(String value) { this.MemberId = value; return this; }
        public Long getDocumentId() { return DocumentId; }
        public LockboxDocument setDocumentId(Long value) { this.DocumentId = value; return this; }
    }

    @DataContract
    public static class ServiceRequestBase implements IHasVersion
    {
        
    }

    @DataContract
    public static 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")
        public Boolean IsSuccessful = null;

        /**
        * The status code returned by the service
        */
        @DataMember
        @ApiMember(Description="The status code returned by the service")
        public Integer StatusCode = null;

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

        @DataMember
        @ApiMember(ExcludeInSchema=true)
        public HashMap<String,String> ServiceDebugFields = null;
        
        public Boolean getIsSuccessful() { return IsSuccessful; }
        public ServiceResponseBase setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
        public Integer getStatusCode() { return StatusCode; }
        public ServiceResponseBase setStatusCode(Integer value) { this.StatusCode = value; return this; }
        public String getStatusMessage() { return StatusMessage; }
        public ServiceResponseBase setStatusMessage(String value) { this.StatusMessage = value; return this; }
        public HashMap<String,String> getServiceDebugFields() { return ServiceDebugFields; }
        public ServiceResponseBase setServiceDebugFields(HashMap<String,String> value) { this.ServiceDebugFields = value; return this; }
    }

}

Java 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>