Starlite API

<back to all web services

AuthenticatedUrl

The following routes are available for this service:
POST/authenticatedUrl
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 AuthenticatedUrl() = 
        inherit ServiceRequestBase()
        ///<summary>
        ///The cmc Id
        ///</summary>
        [<ApiMember(Description="The cmc Id", IsRequired=true)>]
        member val CmcId:String = null with get,set

        ///<summary>
        ///The association Id
        ///</summary>
        [<ApiMember(Description="The association Id")>]
        member val AssociationId:String = null with get,set

        ///<summary>
        ///The Account number of the property
        ///</summary>
        [<ApiMember(Description="The Account number of the property")>]
        member val PropertyAccountNumber:String = null with get,set

        ///<summary>
        ///The User's first name
        ///</summary>
        [<ApiMember(Description="The User's first name")>]
        member val FirstName:String = null with get,set

        ///<summary>
        ///The User's last name
        ///</summary>
        [<ApiMember(Description="The User's last name")>]
        member val LastName:String = null with get,set

        ///<summary>
        ///The User's phone number
        ///</summary>
        [<ApiMember(Description="The User's phone number")>]
        member val Phone:String = null with get,set

        ///<summary>
        ///The User's email
        ///</summary>
        [<ApiMember(Description="The User's email", IsRequired=true)>]
        member val Email:String = null with get,set

        ///<summary>
        ///The vendor's confirmation url
        ///</summary>
        [<ApiMember(Description="The vendor's confirmation url")>]
        member val ConfirmationUrl:String = null with get,set

        ///<summary>
        ///The nickname of the property
        ///</summary>
        [<ApiMember(Description="The nickname of the property")>]
        member val PropertyNickname:String = null with get,set

        ///<summary>
        ///The amount of the payment
        ///</summary>
        [<ApiMember(Description="The amount of the payment")>]
        member val Amount:Decimal = new Decimal() with get,set

        ///<summary>
        ///The bank account number for the payment
        ///</summary>
        [<ApiMember(Description="The bank account number for the payment")>]
        member val BankAccountNumber:String = null with get,set

        ///<summary>
        ///The bank's routing number
        ///</summary>
        [<ApiMember(Description="The bank's routing number")>]
        member val RoutingNumber:String = null with get,set

        ///<summary>
        ///The frequency of the payment
        ///</summary>
        [<ApiMember(Description="The frequency of the payment")>]
        member val PaymentFrequency:String = null with get,set

        ///<summary>
        ///The stylesheet url
        ///</summary>
        [<ApiMember(Description="The stylesheet url")>]
        member val StyleSheet:String = null with get,set

F# AuthenticatedUrl DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"AZW-AABWPW03","ApiServiceHostVersion":"2016.1.18.3"}}