ASP.NET Web API Help Page

POST nano/rpc/loans

Executes calculations to produce loans.

Request Information

URI Parameters

None.

Body Parameters

The form.

Form

Name	Type	Additional information
appId	integer	None.
brokerCompensationTypeId	integer	None.
loanProductId	integer	None.
miRateTypeId	integer	None.
propertyTypeId	integer	None.
userId	integer	None.
additionalPrincipalPaymentAmount	decimal number	None.
additionalPrincipalPaymentFrequency	integer	None.
appraisedValue	decimal number	None.
closingDate	string	None.
communityCode	string	None.
computeAdditionalPrincipalPaymentMethod	string	None.
corporatePartner	string	None.
countyFipsId	string	None.
creditScore	integer	None.
disposableIncome	decimal number	None.
eligibilityCreditScore	integer	None.
escrowsWaived	boolean	None.
excludes	string	None.
forwardCommitmentExternalIdentifier	string	None.
historicalLoanContent	integer	None.
includes	string	None.
isCashOut	boolean	None.
isDefaultOnly	boolean	None.
isScenario	boolean	None.
isUnderConstruction	boolean	None.
loanAmount	decimal number	None.
loanPurpose	string	None.
loanType	LoanType	None.
lockPeriod	integer	None.
occupancyType	string	None.
organization	string	None.
priceAdjustmentAmount	decimal number	None.
priceAdjustmentDescription	string	None.
priceAdjustmentMaxDollarAmount	decimal number	None.
priceAdjustmentTypeId	integer	None.
promoCode	string	None.
rate	decimal number	None.
rateSheetDate	date	None.
salesPrice	decimal number	None.
state	string	None.
viewType	ViewType	None.
existingDebts	Collection of ExistingDebt	None.
otherRates	Collection of decimal number	None.
specialFeatureIds	Collection of string	None.

Request Formats

application/json, text/json, text/html, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The loans.

Collection of Loan

Name	Type	Additional information
amortizationSchedule	AmortizationSchedule	None.
app	integer	None.
disclosureOptions	Collection of DisclosureOption	None.
existingPaymentSchedules	Collection of ExistingPaymentSchedule	None.
findings	Collection of Finding	None.
form	Form	None.
groups	Collection of Group	None.
label	string	None.
id	string	None.
loanType	string	None.
locks		None.

Response Formats

application/json, text/json

Sample:

[
  null,
  {
    "amortizationSchedule": {
      "events": [
        {
          "ap": 1.0,
          "bd": 2.0,
          "bdp": 3.0,
          "i": 4.0,
          "ltv": 5.0,
          "mi": 6.0,
          "d": "0001-01-01",
          "n": 7,
          "p": 8.0,
          "b": 9.0,
          "t": 10.0
        },
        {
          "ap": 1.0,
          "bd": 2.0,
          "bdp": 3.0,
          "i": 4.0,
          "ltv": 5.0,
          "mi": 6.0,
          "d": "0001-01-01",
          "n": 7,
          "p": 8.0,
          "b": 9.0,
          "t": 10.0
        }
      ]
    },
    "app": 1,
    "disclosureOptions": [
      {
        "code": "sample String 1",
        "description": "sample String 2",
        "reasons": [
          "sample String 1",
          "sample String 2"
        ],
        "isAvailable": true,
        "order": 4
      },
      {
        "code": "sample String 1",
        "description": "sample String 2",
        "reasons": [
          "sample String 1",
          "sample String 2"
        ],
        "isAvailable": true,
        "order": 4
      }
    ],
    "existingPaymentSchedules": [
      {
        "debt": {
          "balance": 1.0,
          "loanProgram": "sample String 2",
          "mortgageInsurance": 1.0,
          "name": "sample String 3",
          "originalPropertyValue": 1.0,
          "originalTerm": 1,
          "principalAndInterest": 1.0,
          "rate": 1.0,
          "remainingTerm": 1,
          "repaymentMethodology": "sample String 4",
          "type": "sample String 5"
        },
        "isValid": true,
        "name": "sample String 2",
        "payments": [
          {
            "i": 1.0,
            "mi": 2.0,
            "d": "0001-01-01",
            "n": 3,
            "p": 4.0,
            "b": 5.0,
            "t": 6.0
          },
          {
            "i": 1.0,
            "mi": 2.0,
            "d": "0001-01-01",
            "n": 3,
            "p": 4.0,
            "b": 5.0,
            "t": 6.0
          }
        ],
        "type": "sample String 3"
      },
      {
        "debt": {
          "balance": 1.0,
          "loanProgram": "sample String 2",
          "mortgageInsurance": 1.0,
          "name": "sample String 3",
          "originalPropertyValue": 1.0,
          "originalTerm": 1,
          "principalAndInterest": 1.0,
          "rate": 1.0,
          "remainingTerm": 1,
          "repaymentMethodology": "sample String 4",
          "type": "sample String 5"
        },
        "isValid": true,
        "name": "sample String 2",
        "payments": [
          {
            "i": 1.0,
            "mi": 2.0,
            "d": "0001-01-01",
            "n": 3,
            "p": 4.0,
            "b": 5.0,
            "t": 6.0
          },
          {
            "i": 1.0,
            "mi": 2.0,
            "d": "0001-01-01",
            "n": 3,
            "p": 4.0,
            "b": 5.0,
            "t": 6.0
          }
        ],
        "type": "sample String 3"
      }
    ],
    "findings": [
      {
        "code": "sample String 1",
        "data": {},
        "dataType": "sample String 3",
        "findingCategory": "Unknown",
        "findingType": "AppAudit",
        "details": [
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          },
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          }
        ],
        "message": "sample String 4",
        "severity": "Fatal",
        "severityLevel": 5,
        "source": "sample String 6"
      },
      {
        "code": "sample String 1",
        "data": {},
        "dataType": "sample String 3",
        "findingCategory": "Unknown",
        "findingType": "AppAudit",
        "details": [
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          },
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          }
        ],
        "message": "sample String 4",
        "severity": "Fatal",
        "severityLevel": 5,
        "source": "sample String 6"
      }
    ],
    "form": null,
    "groups": [
      {
        "code": "sample String 1",
        "description": "sample String 2",
        "details": [
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          },
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          }
        ],
        "groups": [],
        "order": 3
      },
      {
        "code": "sample String 1",
        "description": "sample String 2",
        "details": [
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          },
          {
            "code": "sample String 1",
            "description": "sample String 2",
            "id": "sample String 3",
            "details": [],
            "order": 4,
            "type": "Boolean",
            "value": {}
          }
        ],
        "groups": [],
        "order": 3
      }
    ],
    "label": "sample String 1",
    "id": "sample String 2",
    "loanType": "Existing",
    "locks": [],
    "payment": null,
    "pricingEngine": null,
    "selection": null,
    "views": []
  }
]

text/html

Sample:

[null,{"amortizationSchedule":{"events":[{"ap":1.0,"bd":2.0,"bdp":3.0,"i":4.0,"ltv":5.0,"mi":6.0,"d":"0001-01-01","n":7,"p":8.0,"b":9.0,"t":10.0},{"ap":1.0,"bd":2.0,"bdp":3.0,"i":4.0,"ltv":5.0,"mi":6.0,"d":"0001-01-01","n":7,"p":8.0,"b":9.0,"t":10.0}]},"app":1,"disclosureOptions":[{"code":"sample String 1","description":"sample String 2","reasons":["sample String 1","sample String 2"],"isAvailable":true,"order":4},{"code":"sample String 1","description":"sample String 2","reasons":["sample String 1","sample String 2"],"isAvailable":true,"order":4}],"existingPaymentSchedules":[{"debt":{"balance":1.0,"loanProgram":"sample String 2","mortgageInsurance":1.0,"name":"sample String 3","originalPropertyValue":1.0,"originalTerm":1,"principalAndInterest":1.0,"rate":1.0,"remainingTerm":1,"repaymentMethodology":"sample String 4","type":"sample String 5"},"isValid":true,"name":"sample String 2","payments":[{"i":1.0,"mi":2.0,"d":"0001-01-01","n":3,"p":4.0,"b":5.0,"t":6.0},{"i":1.0,"mi":2.0,"d":"0001-01-01","n":3,"p":4.0,"b":5.0,"t":6.0}],"type":"sample String 3"},{"debt":{"balance":1.0,"loanProgram":"sample String 2","mortgageInsurance":1.0,"name":"sample String 3","originalPropertyValue":1.0,"originalTerm":1,"principalAndInterest":1.0,"rate":1.0,"remainingTerm":1,"repaymentMethodology":"sample String 4","type":"sample String 5"},"isValid":true,"name":"sample String 2","payments":[{"i":1.0,"mi":2.0,"d":"0001-01-01","n":3,"p":4.0,"b":5.0,"t":6.0},{"i":1.0,"mi":2.0,"d":"0001-01-01","n":3,"p":4.0,"b":5.0,"t":6.0}],"type":"sample String 3"}],"findings":[{"code":"sample String 1","data":{},"dataType":"sample String 3","findingCategory":"Unknown","findingType":"AppAudit","details":[{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}},{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}}],"message":"sample String 4","severity":"Fatal","severityLevel":5,"source":"sample String 6"},{"code":"sample String 1","data":{},"dataType":"sample String 3","findingCategory":"Unknown","findingType":"AppAudit","details":[{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}},{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}}],"message":"sample String 4","severity":"Fatal","severityLevel":5,"source":"sample String 6"}],"form":null,"groups":[{"code":"sample String 1","description":"sample String 2","details":[{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}},{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}}],"groups":[],"order":3},{"code":"sample String 1","description":"sample String 2","details":[{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}},{"code":"sample String 1","description":"sample String 2","id":"sample String 3","details":[],"order":4,"type":"Boolean","value":{}}],"groups":[],"order":3}],"label":"sample String 1","id":"sample String 2","loanType":"Existing","locks":[],"payment":null,"pricingEngine":null,"selection":null,"views":[]}]

application/vnd.api+json

Sample:

Sample not available.