| POST | /Members/LockboxDocument |
|---|
namespace Babel.Framework.ApiContext
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ServiceResponseBase() =
///<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")>]
member val IsSuccessful:Boolean = new Boolean() with get,set
///<summary>
///The status code returned by the service
///</summary>
[<DataMember>]
[<ApiMember(Description="The status code returned by the service")>]
member val StatusCode:Int32 = new Int32() with get,set
///<summary>
///The status message returned by the service
///</summary>
[<DataMember>]
[<ApiMember(Description="The status message returned by the service")>]
member val StatusMessage:String = null with get,set
[<DataMember>]
[<ApiMember(ExcludeInSchema=true)>]
member val ServiceDebugFields:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ServiceRequestBase() =
class end
[<AllowNullLiteral>]
type LockboxDocument() =
inherit 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)>]
member val ManagementCompanyId:String = null with get,set
///<summary>
///The association company that the member belongs to
///</summary>
[<ApiMember(Description="The association company that the member belongs to", IsRequired=true)>]
member val AssociationId:String = null with 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)>]
member val MemberId:String = null with 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)>]
member val DocumentId:Int64 = new Int64() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>