Starlite API

<back to all web services

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

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>