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.*;

public class dtos
{

    public static class AuthenticatedUrl extends ServiceRequestBase
    {
        /**
        * The cmc Id
        */
        @ApiMember(Description="The cmc Id", IsRequired=true)
        public String CmcId = null;

        /**
        * The association Id
        */
        @ApiMember(Description="The association Id")
        public String AssociationId = null;

        /**
        * The Account number of the property
        */
        @ApiMember(Description="The Account number of the property")
        public String PropertyAccountNumber = null;

        /**
        * The User's first name
        */
        @ApiMember(Description="The User's first name")
        public String FirstName = null;

        /**
        * The User's last name
        */
        @ApiMember(Description="The User's last name")
        public String LastName = null;

        /**
        * The User's phone number
        */
        @ApiMember(Description="The User's phone number")
        public String Phone = null;

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

        /**
        * The vendor's confirmation url
        */
        @ApiMember(Description="The vendor's confirmation url")
        public String ConfirmationUrl = null;

        /**
        * The nickname of the property
        */
        @ApiMember(Description="The nickname of the property")
        public String PropertyNickname = null;

        /**
        * The amount of the payment
        */
        @ApiMember(Description="The amount of the payment")
        public BigDecimal Amount = null;

        /**
        * The bank account number for the payment
        */
        @ApiMember(Description="The bank account number for the payment")
        public String BankAccountNumber = null;

        /**
        * The bank's routing number
        */
        @ApiMember(Description="The bank's routing number")
        public String RoutingNumber = null;

        /**
        * The frequency of the payment
        */
        @ApiMember(Description="The frequency of the payment")
        public String PaymentFrequency = null;

        /**
        * The stylesheet url
        */
        @ApiMember(Description="The stylesheet url")
        public String StyleSheet = null;
        
        public String getCmcId() { return CmcId; }
        public AuthenticatedUrl setCmcId(String value) { this.CmcId = value; return this; }
        public String getAssociationId() { return AssociationId; }
        public AuthenticatedUrl setAssociationId(String value) { this.AssociationId = value; return this; }
        public String getPropertyAccountNumber() { return PropertyAccountNumber; }
        public AuthenticatedUrl setPropertyAccountNumber(String value) { this.PropertyAccountNumber = value; return this; }
        public String getFirstName() { return FirstName; }
        public AuthenticatedUrl setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public AuthenticatedUrl setLastName(String value) { this.LastName = value; return this; }
        public String getPhone() { return Phone; }
        public AuthenticatedUrl setPhone(String value) { this.Phone = value; return this; }
        public String getEmail() { return Email; }
        public AuthenticatedUrl setEmail(String value) { this.Email = value; return this; }
        public String getConfirmationUrl() { return ConfirmationUrl; }
        public AuthenticatedUrl setConfirmationUrl(String value) { this.ConfirmationUrl = value; return this; }
        public String getPropertyNickname() { return PropertyNickname; }
        public AuthenticatedUrl setPropertyNickname(String value) { this.PropertyNickname = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public AuthenticatedUrl setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getBankAccountNumber() { return BankAccountNumber; }
        public AuthenticatedUrl setBankAccountNumber(String value) { this.BankAccountNumber = value; return this; }
        public String getRoutingNumber() { return RoutingNumber; }
        public AuthenticatedUrl setRoutingNumber(String value) { this.RoutingNumber = value; return this; }
        public String getPaymentFrequency() { return PaymentFrequency; }
        public AuthenticatedUrl setPaymentFrequency(String value) { this.PaymentFrequency = value; return this; }
        public String getStyleSheet() { return StyleSheet; }
        public AuthenticatedUrl setStyleSheet(String value) { this.StyleSheet = value; return this; }
    }

    @DataContract
    public static class ServiceRequestBase implements IHasVersion
    {
        
    }

    @DataContract
    public static 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")
        public Boolean IsSuccessful = null;

        /**
        * The status code returned by the service
        */
        @DataMember
        @ApiMember(Description="The status code returned by the service")
        public Integer StatusCode = null;

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

        @DataMember
        @ApiMember(ExcludeInSchema=true)
        public HashMap<String,String> ServiceDebugFields = null;
        
        public Boolean getIsSuccessful() { return IsSuccessful; }
        public ServiceResponseBase setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
        public Integer getStatusCode() { return StatusCode; }
        public ServiceResponseBase setStatusCode(Integer value) { this.StatusCode = value; return this; }
        public String getStatusMessage() { return StatusMessage; }
        public ServiceResponseBase setStatusMessage(String value) { this.StatusMessage = value; return this; }
        public HashMap<String,String> getServiceDebugFields() { return ServiceDebugFields; }
        public ServiceResponseBase setServiceDebugFields(HashMap<String,String> value) { this.ServiceDebugFields = value; return this; }
    }

}

Java 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
	}
}