Starlite API

<back to all web services

AuthenticatedUrl

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceRequestBase(IReturn[ServiceResponseBase], IHasVersion):
    @staticmethod
    def response_type(): return ServiceResponseBase


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceResponseBase:
    # @ApiMember(Description="Identifies whether the request executed successfully, however does not indicated requested data was found")
    is_successful: Optional[bool] = None
    """
    Identifies whether the request executed successfully, however does not indicated requested data was found
    """


    # @ApiMember(Description="The status code returned by the service")
    status_code: Optional[int] = None
    """
    The status code returned by the service
    """


    # @ApiMember(Description="The status message returned by the service")
    status_message: Optional[str] = None
    """
    The status message returned by the service
    """


    # @ApiMember(ExcludeInSchema=true)
    service_debug_fields: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthenticatedUrl(ServiceRequestBase):
    # @ApiMember(Description="The cmc Id", IsRequired=true)
    cmc_id: Optional[str] = None
    """
    The cmc Id
    """


    # @ApiMember(Description="The association Id")
    association_id: Optional[str] = None
    """
    The association Id
    """


    # @ApiMember(Description="The Account number of the property")
    property_account_number: Optional[str] = None
    """
    The Account number of the property
    """


    # @ApiMember(Description="The User's first name")
    first_name: Optional[str] = None
    """
    The User's first name
    """


    # @ApiMember(Description="The User's last name")
    last_name: Optional[str] = None
    """
    The User's last name
    """


    # @ApiMember(Description="The User's phone number")
    phone: Optional[str] = None
    """
    The User's phone number
    """


    # @ApiMember(Description="The User's email", IsRequired=true)
    email: Optional[str] = None
    """
    The User's email
    """


    # @ApiMember(Description="The vendor's confirmation url")
    confirmation_url: Optional[str] = None
    """
    The vendor's confirmation url
    """


    # @ApiMember(Description="The nickname of the property")
    property_nickname: Optional[str] = None
    """
    The nickname of the property
    """


    # @ApiMember(Description="The amount of the payment")
    amount: Optional[Decimal] = None
    """
    The amount of the payment
    """


    # @ApiMember(Description="The bank account number for the payment")
    bank_account_number: Optional[str] = None
    """
    The bank account number for the payment
    """


    # @ApiMember(Description="The bank's routing number")
    routing_number: Optional[str] = None
    """
    The bank's routing number
    """


    # @ApiMember(Description="The frequency of the payment")
    payment_frequency: Optional[str] = None
    """
    The frequency of the payment
    """


    # @ApiMember(Description="The stylesheet url")
    style_sheet: Optional[str] = None
    """
    The stylesheet url
    """

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