| POST | /Accounts/AccountHistory |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Babel.Framework.ApiPlugins.Starlite.AccountTransactions;
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.AccountTransactions
{
[DataContract]
public partial class AccountHistory
: ServiceRequestBase
{
public AccountHistory()
{
AccountNumbers = new List<long>{};
TransactionCodes = new List<int>{};
}
///<summary>
///The property manager ID (or customer code ID) that can manage the account(s) requested
///</summary>
[DataMember]
[ApiMember(DataType="string", Description="The property manager ID (or customer code ID) that can manage the account(s) requested")]
public virtual string ManagementCompanyId { get; set; }
///<summary>
///The list of account numbers for which to receive transaction data
///</summary>
[DataMember]
[ApiMember(DataType="List<long>", Description="The list of account numbers for which to receive transaction data")]
public virtual List<long> AccountNumbers { get; set; }
///<summary>
///The earliest date (in short DateTime format) for which to find transactions in the specified date range
///</summary>
[DataMember]
[ApiMember(DataType="DateTime", Description="The earliest date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)]
public virtual DateTime FromDate { get; set; }
///<summary>
///The most recent date (in short DateTime format) for which to find transactions in the specified date range
///</summary>
[DataMember]
[ApiMember(DataType="DateTime", Description="The most recent date (in short DateTime format) for which to find transactions in the specified date range", IsRequired=true)]
public virtual DateTime ToDate { get; set; }
///<summary>
///An array of external transaction codes for filtering the transactions in the response
///</summary>
[DataMember]
[ApiMember(DataType="List<string>", Description="An array of external transaction codes for filtering the transactions in the response")]
public virtual List<int> TransactionCodes { 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 /Accounts/AccountHistory HTTP/1.1
Host: services.allianceassociationbank.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AccountHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.AccountTransactions">
<AccountNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>0</d2p1:long>
</AccountNumbers>
<FromDate>0001-01-01T00:00:00</FromDate>
<ManagementCompanyId>String</ManagementCompanyId>
<ToDate>0001-01-01T00:00:00</ToDate>
<TransactionCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</TransactionCodes>
</AccountHistory>
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>