Starlite API

<back to all web services

LockboxDocument

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Babel.Framework.ApiPlugins.Starlite.LockboxDocuments;
using Babel.Framework.ApiContext;

namespace Babel.Framework.ApiContext
{
    [DataContract]
    public partial class ServiceRequestBase
        : IHasVersion
    {
    }

    [DataContract]
    public partial class ServiceResponseBase
    {
        public ServiceResponseBase()
        {
            ServiceDebugFields = new Dictionary<string, string>{};
        }

        ///<summary>
        ///Identifies whether the request executed successfully, however does not indicated requested data was found
        ///</summary>
        [DataMember]
        [ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")]
        public virtual bool IsSuccessful { get; set; }

        ///<summary>
        ///The status code returned by the service
        ///</summary>
        [DataMember]
        [ApiMember(Description="The status code returned by the service")]
        public virtual int StatusCode { get; set; }

        ///<summary>
        ///The status message returned by the service
        ///</summary>
        [DataMember]
        [ApiMember(Description="The status message returned by the service")]
        public virtual string StatusMessage { get; set; }

        [DataMember]
        [ApiMember(ExcludeInSchema=true)]
        public virtual Dictionary<string, string> ServiceDebugFields { get; set; }
    }

}

namespace Babel.Framework.ApiPlugins.Starlite.LockboxDocuments
{
    public partial class LockboxDocument
        : ServiceRequestBase
    {
        ///<summary>
        ///The management company that the member's association belongs to
        ///</summary>
        [ApiMember(Description="The management company that the member's association belongs to", IsRequired=true)]
        public virtual string ManagementCompanyId { get; set; }

        ///<summary>
        ///The association company that the member belongs to
        ///</summary>
        [ApiMember(Description="The association company that the member belongs to", IsRequired=true)]
        public virtual string AssociationId { get; set; }

        ///<summary>
        ///The member ID for whom to retrieve the lockbox document for
        ///</summary>
        [ApiMember(Description="The member ID for whom to retrieve the lockbox document for", IsRequired=true)]
        public virtual string MemberId { get; set; }

        ///<summary>
        ///The lockbox document ID identifying which document to pull
        ///</summary>
        [ApiMember(Description="The lockbox document ID identifying which document to pull", IsRequired=true)]
        public virtual long DocumentId { get; set; }
    }

}

C# 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>