| POST | /authenticatedUrl |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Babel.Framework.ApiPlugins.Starlite.SingleSignOn;
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.SingleSignOn
{
public partial class AuthenticatedUrl
: ServiceRequestBase
{
///<summary>
///The cmc Id
///</summary>
[ApiMember(Description="The cmc Id", IsRequired=true)]
public virtual string CmcId { get; set; }
///<summary>
///The association Id
///</summary>
[ApiMember(Description="The association Id")]
public virtual string AssociationId { get; set; }
///<summary>
///The Account number of the property
///</summary>
[ApiMember(Description="The Account number of the property")]
public virtual string PropertyAccountNumber { get; set; }
///<summary>
///The User's first name
///</summary>
[ApiMember(Description="The User's first name")]
public virtual string FirstName { get; set; }
///<summary>
///The User's last name
///</summary>
[ApiMember(Description="The User's last name")]
public virtual string LastName { get; set; }
///<summary>
///The User's phone number
///</summary>
[ApiMember(Description="The User's phone number")]
public virtual string Phone { get; set; }
///<summary>
///The User's email
///</summary>
[ApiMember(Description="The User's email", IsRequired=true)]
public virtual string Email { get; set; }
///<summary>
///The vendor's confirmation url
///</summary>
[ApiMember(Description="The vendor's confirmation url")]
public virtual string ConfirmationUrl { get; set; }
///<summary>
///The nickname of the property
///</summary>
[ApiMember(Description="The nickname of the property")]
public virtual string PropertyNickname { get; set; }
///<summary>
///The amount of the payment
///</summary>
[ApiMember(Description="The amount of the payment")]
public virtual decimal Amount { get; set; }
///<summary>
///The bank account number for the payment
///</summary>
[ApiMember(Description="The bank account number for the payment")]
public virtual string BankAccountNumber { get; set; }
///<summary>
///The bank's routing number
///</summary>
[ApiMember(Description="The bank's routing number")]
public virtual string RoutingNumber { get; set; }
///<summary>
///The frequency of the payment
///</summary>
[ApiMember(Description="The frequency of the payment")]
public virtual string PaymentFrequency { get; set; }
///<summary>
///The stylesheet url
///</summary>
[ApiMember(Description="The stylesheet url")]
public virtual string StyleSheet { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /authenticatedUrl HTTP/1.1
Host: services.allianceassociationbank.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CmcId: String,
AssociationId: String,
PropertyAccountNumber: String,
FirstName: String,
LastName: String,
Phone: String,
Email: String,
ConfirmationUrl: String,
PropertyNickname: String,
Amount: 0,
BankAccountNumber: String,
RoutingNumber: String,
PaymentFrequency: String,
StyleSheet: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsSuccessful: False,
StatusCode: 0,
StatusMessage: String,
ServiceDebugFields:
{
ApiServiceHost: WAB-WEBPW02,
ApiServiceHostVersion: 1.0.0.0
}
}