Starlite API

<back to all web services

AuthenticatedUrl

The following routes are available for this service:
POST/authenticatedUrl
import java.math.*
import java.util.*
import net.servicestack.client.*


open class AuthenticatedUrl : ServiceRequestBase()
{
    /**
    * The cmc Id
    */
    @ApiMember(Description="The cmc Id", IsRequired=true)
    var CmcId:String? = null

    /**
    * The association Id
    */
    @ApiMember(Description="The association Id")
    var AssociationId:String? = null

    /**
    * The Account number of the property
    */
    @ApiMember(Description="The Account number of the property")
    var PropertyAccountNumber:String? = null

    /**
    * The User's first name
    */
    @ApiMember(Description="The User's first name")
    var FirstName:String? = null

    /**
    * The User's last name
    */
    @ApiMember(Description="The User's last name")
    var LastName:String? = null

    /**
    * The User's phone number
    */
    @ApiMember(Description="The User's phone number")
    var Phone:String? = null

    /**
    * The User's email
    */
    @ApiMember(Description="The User's email", IsRequired=true)
    var Email:String? = null

    /**
    * The vendor's confirmation url
    */
    @ApiMember(Description="The vendor's confirmation url")
    var ConfirmationUrl:String? = null

    /**
    * The nickname of the property
    */
    @ApiMember(Description="The nickname of the property")
    var PropertyNickname:String? = null

    /**
    * The amount of the payment
    */
    @ApiMember(Description="The amount of the payment")
    var Amount:BigDecimal? = null

    /**
    * The bank account number for the payment
    */
    @ApiMember(Description="The bank account number for the payment")
    var BankAccountNumber:String? = null

    /**
    * The bank's routing number
    */
    @ApiMember(Description="The bank's routing number")
    var RoutingNumber:String? = null

    /**
    * The frequency of the payment
    */
    @ApiMember(Description="The frequency of the payment")
    var PaymentFrequency:String? = null

    /**
    * The stylesheet url
    */
    @ApiMember(Description="The stylesheet url")
    var StyleSheet:String? = null
}

@DataContract
open class ServiceRequestBase : IHasVersion
{
}

@DataContract
open class ServiceResponseBase
{
    /**
    * Identifies whether the request executed successfully, however does not indicated requested data was found
    */
    @DataMember
    @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    var IsSuccessful:Boolean? = null

    /**
    * The status code returned by the service
    */
    @DataMember
    @ApiMember(Description="The status code returned by the service")
    var StatusCode:Int? = null

    /**
    * The status message returned by the service
    */
    @DataMember
    @ApiMember(Description="The status message returned by the service")
    var StatusMessage:String? = null

    @DataMember
    @ApiMember(ExcludeInSchema=true)
    var ServiceDebugFields:HashMap<String,String> = HashMap<String,String>()
}

Kotlin AuthenticatedUrl DTOs

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

HTTP + 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
	}
}