| POST | /authenticatedUrl |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Babel.Framework.ApiPlugins.Starlite.SingleSignOn
Imports Babel.Framework.ApiContext
Namespace Global
Namespace Babel.Framework.ApiContext
<DataContract>
Public Partial Class ServiceRequestBase
Implements IHasVersion
End Class
<DataContract>
Public Partial Class ServiceResponseBase
Public Sub New()
ServiceDebugFields = New Dictionary(Of String, String)
End Sub
'''<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 Overridable Property IsSuccessful As Boolean
'''<Summary>
'''The status code returned by the service
'''</Summary>
<DataMember>
<ApiMember(Description:="The status code returned by the service")>
Public Overridable Property StatusCode As Integer
'''<Summary>
'''The status message returned by the service
'''</Summary>
<DataMember>
<ApiMember(Description:="The status message returned by the service")>
Public Overridable Property StatusMessage As String
<DataMember>
<ApiMember(ExcludeInSchema:=true)>
Public Overridable Property ServiceDebugFields As Dictionary(Of String, String)
End Class
End Namespace
Namespace Babel.Framework.ApiPlugins.Starlite.SingleSignOn
Public Partial Class AuthenticatedUrl
Inherits ServiceRequestBase
'''<Summary>
'''The cmc Id
'''</Summary>
<ApiMember(Description:="The cmc Id", IsRequired:=true)>
Public Overridable Property CmcId As String
'''<Summary>
'''The association Id
'''</Summary>
<ApiMember(Description:="The association Id")>
Public Overridable Property AssociationId As String
'''<Summary>
'''The Account number of the property
'''</Summary>
<ApiMember(Description:="The Account number of the property")>
Public Overridable Property PropertyAccountNumber As String
'''<Summary>
'''The User's first name
'''</Summary>
<ApiMember(Description:="The User's first name")>
Public Overridable Property FirstName As String
'''<Summary>
'''The User's last name
'''</Summary>
<ApiMember(Description:="The User's last name")>
Public Overridable Property LastName As String
'''<Summary>
'''The User's phone number
'''</Summary>
<ApiMember(Description:="The User's phone number")>
Public Overridable Property Phone As String
'''<Summary>
'''The User's email
'''</Summary>
<ApiMember(Description:="The User's email", IsRequired:=true)>
Public Overridable Property Email As String
'''<Summary>
'''The vendor's confirmation url
'''</Summary>
<ApiMember(Description:="The vendor's confirmation url")>
Public Overridable Property ConfirmationUrl As String
'''<Summary>
'''The nickname of the property
'''</Summary>
<ApiMember(Description:="The nickname of the property")>
Public Overridable Property PropertyNickname As String
'''<Summary>
'''The amount of the payment
'''</Summary>
<ApiMember(Description:="The amount of the payment")>
Public Overridable Property Amount As Decimal
'''<Summary>
'''The bank account number for the payment
'''</Summary>
<ApiMember(Description:="The bank account number for the payment")>
Public Overridable Property BankAccountNumber As String
'''<Summary>
'''The bank's routing number
'''</Summary>
<ApiMember(Description:="The bank's routing number")>
Public Overridable Property RoutingNumber As String
'''<Summary>
'''The frequency of the payment
'''</Summary>
<ApiMember(Description:="The frequency of the payment")>
Public Overridable Property PaymentFrequency As String
'''<Summary>
'''The stylesheet url
'''</Summary>
<ApiMember(Description:="The stylesheet url")>
Public Overridable Property StyleSheet As String
End Class
End Namespace
End Namespace
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 /authenticatedUrl HTTP/1.1
Host: services.allianceassociationbank.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AuthenticatedUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Babel.Framework.ApiPlugins.Starlite.SingleSignOn">
<Amount>0</Amount>
<AssociationId>String</AssociationId>
<BankAccountNumber>String</BankAccountNumber>
<CmcId>String</CmcId>
<ConfirmationUrl>String</ConfirmationUrl>
<Email>String</Email>
<FirstName>String</FirstName>
<LastName>String</LastName>
<PaymentFrequency>String</PaymentFrequency>
<Phone>String</Phone>
<PropertyAccountNumber>String</PropertyAccountNumber>
<PropertyNickname>String</PropertyNickname>
<RoutingNumber>String</RoutingNumber>
<StyleSheet>String</StyleSheet>
</AuthenticatedUrl>
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>AZW-AABWPW03</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>ApiServiceHostVersion</d2p1:Key>
<d2p1:Value>2016.1.18.3</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</ServiceDebugFields>
<StatusCode>0</StatusCode>
<StatusMessage>String</StatusMessage>
</ServiceResponseBase>