Starlite API

<back to all web services

AuthenticatedUrl

// @DataContract
export class ServiceRequestBase implements IHasVersion
{

    public constructor(init?: Partial<ServiceRequestBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export 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 IsSuccessful?: boolean;

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

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

    // @DataMember
    // @ApiMember(ExcludeInSchema=true)
    public ServiceDebugFields?: { [index: string]: string; };

    public constructor(init?: Partial<ServiceResponseBase>) { (Object as any).assign(this, init); }
}

export class AuthenticatedUrl extends ServiceRequestBase
{
    /**
    * The cmc Id
    */
    // @ApiMember(Description="The cmc Id", IsRequired=true)
    public CmcId?: string;

    /**
    * The association Id
    */
    // @ApiMember(Description="The association Id")
    public AssociationId?: string;

    /**
    * The Account number of the property
    */
    // @ApiMember(Description="The Account number of the property")
    public PropertyAccountNumber?: string;

    /**
    * The User's first name
    */
    // @ApiMember(Description="The User's first name")
    public FirstName?: string;

    /**
    * The User's last name
    */
    // @ApiMember(Description="The User's last name")
    public LastName?: string;

    /**
    * The User's phone number
    */
    // @ApiMember(Description="The User's phone number")
    public Phone?: string;

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

    /**
    * The vendor's confirmation url
    */
    // @ApiMember(Description="The vendor's confirmation url")
    public ConfirmationUrl?: string;

    /**
    * The nickname of the property
    */
    // @ApiMember(Description="The nickname of the property")
    public PropertyNickname?: string;

    /**
    * The amount of the payment
    */
    // @ApiMember(Description="The amount of the payment")
    public Amount?: number;

    /**
    * The bank account number for the payment
    */
    // @ApiMember(Description="The bank account number for the payment")
    public BankAccountNumber?: string;

    /**
    * The bank's routing number
    */
    // @ApiMember(Description="The bank's routing number")
    public RoutingNumber?: string;

    /**
    * The frequency of the payment
    */
    // @ApiMember(Description="The frequency of the payment")
    public PaymentFrequency?: string;

    /**
    * The stylesheet url
    */
    // @ApiMember(Description="The stylesheet url")
    public StyleSheet?: string;

    public constructor(init?: Partial<AuthenticatedUrl>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AuthenticatedUrl DTOs

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