monorepo/LCU.API.Internal.OnlineLoanApp/Landmark.OLA.Application/Landmark.OLA.Application.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Landmark.OLA.Application</name>
    </assembly>
    <members>
        <member name="M:Landmark.OLA.Application.Controllers.AddressValidationController.Post(Landmark.OLA.Models.Addresses.Address)">
            <summary>
            Use to correct a postal address
            </summary>
            <remarks>
            Returns a service corrected postal address, given a postal address.
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.BranchConfigController.Get">
            <summary>
            Use to get the branch configuration
            </summary>
            <remarks>
            Returns a full branch configuration.
            Cookies: None required or set.
            Security: None.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.BranchConfigController.Post(Landmark.OLA.Models.Loan.BranchConfig)">
            <summary>
            Use to save the initial branch config. 
            </summary>
            <remarks>
            Returns a saved branch config with id. This call will fail if ANY configs currently exist.
            Cookies: None required or set.
            Security: Requires Azure AD Jwt token and admin role.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.BranchConfigController.Put(Landmark.OLA.Models.Loan.BranchConfig)">
            <summary>
            Use update the branch config
            </summary>
            <remarks>
            Returns a status after attempting to update the branch configuration.
            Cookies: None required or set.
            Security: Must have a valid JWT token retrieved from Azure AD, with ADMIN role. 
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.DecisioningController.Put(System.String,Landmark.OLA.Models.Decisioning.DecisioningDetails)">
            <summary>
            Use to start decisioning on a loan
            </summary>
            <remarks>
            Returns status of decision start, on 202 you can begin requesting details.
            Cookies: Will expire existing cookies.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.DecisioningController.Get(System.String)">
            <summary>
            Use to get details of a decision
            </summary>
            <remarks>
            Returns a decision status, which may be empty if the decision is not ready.
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.LoanApplicationController.Post(System.String)">
            <summary>
            Use to transmit an existing loan application to CRIF Lending
            </summary>
            <remarks>
            Transmits a loan application to CRIF lending given a loan storage id (not a loan id).
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.LoanApplicationController.Post(Landmark.OLA.Models.Loan.LoanApplication)">
            <summary>
            Use to transmit a new loan application directly to CRIF Lending
            </summary>
            <remarks>
            Transmits a loan application directly to CRIF Lending given a valid loan application.
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.LoggingController.Post(Landmark.OLA.Models.ClientError)">
            <summary>
            Use to send something to the logger from the client
            </summary>
            <remarks>
            Logs a message from a client.
            Cookies: None required or set.
            Security: Must have a valid JWT token retrieved from Azure AD, with ADMIN role.
            </remarks>       
        </member>
		<member name="M:Landmark.OLA.Application.Controllers.PdfController.Get(System.String)">
			<summary>
				Use to get the pdfs
			</summary>
			<remarks>
				Returns bytes of PDF.
				Cookies: None required or set.
				Security: None required or provided.
			</remarks>
		</member>
        <member name="M:Landmark.OLA.Application.Controllers.SAMLAssertionConsumerController.Post(OnlineBankingAuth.Parsers.SAMLMessaging)">
            <summary>
            Use to refer a user to the application with a valid SAML assertion
            </summary>
            <remarks>
            Returns an application redirect, adding in a SAML assertion via a JWT in a secure http-only cookie.
            Cookies: Set a standard pair of authentication and authorization cookies.
            Security: Passed document must include a valid, signed SAML assertion, provides member authentication.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.SAMLAssertionConsumerController.Get">
            <summary>
            Use to create an empty cookie session
            </summary>
            <remarks>
            Returns a pair of empty authorization and authentication cookies.
            Cookies: Sets empty Authentication and Authorization cookies.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.SAMLAssertionConsumerController.PostAsync(Landmark.OLA.Models.OnlineBanking.OnlineBankingFormData)">
            <summary>
            Use to create a cookie session with credentials
            </summary>
            <remarks>
            Returns a pair of authorization and authentication cookies when provided with valid credentials.
            Cookies: Sets Authentication and Authorization cookies.
            Security: Require.
            </remarks>    
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.SAMLAssertionConsumerController.PostIdentify(Landmark.OLA.Application.Controllers.OnlineIdentityFormData)">
            <summary>
            Use to identify a unique individual on the member account.
            </summary>
            <remarks>
            Returns OK if an individual ID was added to the cookie.
            Cookies: Sets Individual ID in cookie.
            Security: Requires existing cookie, with member.
            </remarks>    
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StatusController.GetRoot">
            <summary>
            Attempts to load the root of the API result in a web-app redirect.
            </summary>
            <remarks>
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StatusController.GetCoreTest(System.String)">
            <summary>
            Attempts to load a website and return the reponse.
            </summary>
            <remarks>
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StatusController.Get">
            <summary>
            Use to get the status of the api
            </summary>
            <remarks>
            Returns a simple object describing the build time, version, and environment of the running API.
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.Post(Landmark.OLA.Models.Loan.Filter)">
            <summary>
            Use to retrieve a set of Loan Containers by filter
            </summary>
            <remarks>
            Returns an array of Loan Containers given a filter
            Cookies: None required or set.
            Security: Must have a valid JWT token retrieved from Azure AD, with ADMIN role.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.Get(System.String)">
            <summary>
            Use to get a specific loan container
            </summary>
            <remarks>
            Returns a loan container given a loan id.
            Cookies: None required or set.
            Security: Must have a valid JWT token retrieved from Azure AD.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.GetMemberApplications">
            <summary>
            Use to get loan containers for an authenticated member
            </summary>
            <remarks>
            Returns a list of loan containers given a valid cookie with member id.
            Cookies: Requires authenticated cookie with member id.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.Post(Landmark.OLA.Models.Loan.LoanContainer)">
            <summary>
            Use to save a loan container
            </summary>
            <remarks>
            Returns a saved loan container with id and possibly member id
            Cookies: Authenticated member cookie optional, will cause id to be saved.
            Security: Currently creates authentication and authorization cookies.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.Put(Landmark.OLA.Models.Loan.LoanContainer)">
            <summary>
            Use update a loan container
            </summary>
            <remarks>
            Returns a status after attempting to update a loan container with new info.
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.DeleteLoan(System.String)">
            <summary>
            Use to delete a loan
            </summary>
            <remarks>
            Deletes a loan given an id.
            Cookies: None required or set.
            Security: Requires JWT token from Azure AD, AND Admin role.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.StorageController.DeleteContainer(System.String)">
            <summary>
            Use to delete an entire loan container
            </summary>
            <remarks>
            Deletes a loan container given a container id.
            Cookies: None required or set.
            Security: Requires JWT token from Azure AD, AND Admin role.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.UiSettingsController.Get">
            <summary>
            Use to retrieve UI Settings
            </summary>
            <remarks>
            Returns the UI Settings; with the dynamic branch mappings injected.
            Cookies: None required or set.
            Security: None required or provided.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.UiSettingsController.GetStoredSettings">
            <summary>
            Use to get stored config (run-time changeable)
            </summary>
            <remarks>
            Returns the current StoredConfig
            Cookies: None required or set.
            Security: Requires Azure AD token and Admin role.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.UiSettingsController.CreateStoredSettings(Landmark.OLA.Application.Common.Domain.StoredSettings)">
            <summary>
            Use to save the initial storedConfig. 
            </summary>
            <remarks>
            Returns a saved configuration with id. This call will fail if ANY configs currently exist.
            Cookies: None required or set.
            Security: Requires Azure AD Jwt token and admin role.
            </remarks>       
        </member>
        <member name="M:Landmark.OLA.Application.Controllers.UiSettingsController.UpdateStoredSettings(Landmark.OLA.Application.Common.Domain.StoredSettings)">
            <summary>
            Use update the StoredConfig
            </summary>
            <remarks>
            Returns a status after attempting to update the StoredConfig.
            Cookies: None required or set.
            Security: Must have a valid JWT token retrieved from Azure AD, with ADMIN role. 
            </remarks>       
        </member>
    </members>
</doc>