Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of loan products.

Collection of Nano.LoanProduct
NameDescriptionTypeAdditional information
amortizationType

Gets or sets the type of the amortization.

string

None.

description

Gets or sets the description.

string

None.

displayOrder

Gets or sets the display order.

integer

None.

hasDownPaymentAssistance

Gets or sets a value indicating whether this has down payment assistance.

boolean

None.

hasIncomeRestrictions

Gets or sets a value indicating whether the loan product has income restrictions.

boolean

None.

internalEnabled

Gets or sets a value indicating whether this is internal enabled.

boolean

None.

isActive

Gets or sets a value indicating whether this is active.

boolean

None.

isBrokered

Gets or sets a value indicating whether this is btr.

boolean

None.

isHedgeable

Gets or sets the is hedgeable.

boolean

None.

isPublic

Gets or sets a value indicating whether this is public.

boolean

None.

isSubjectToMI

Gets or sets a value indicating whether this is subject to MI.

boolean

None.

minMiLtv

Gets or sets the minimum MI LTV.

decimal number

None.

nickname

Gets or sets the nickname.

string

None.

productCode

Gets or sets the Product Code.

string

None.

requiresTargetRate

Gets or sets a value indicating whether this Requires Target Rate.

boolean

None.

state

Gets or sets the state.

string

None.

tier

Gets or sets the tier.

integer

None.

term

Gets or sets the term.

integer

None.

armTerm

Gets or sets the ARM term identifier.

integer

None.

defaultDocumentationType

Gets or sets the default documentation type identifier.

integer

None.

id

Gets or sets the loan product identifier.

integer

None.

loanProgram

Gets or sets the loan program identifier.

integer

None.

forwardCommitments

Gets or sets the forward commitment identifiers.

Collection of integer

None.

specialFeatures

Gets or sets the special feature identifiers.

Collection of string

None.

lockHistories

Gets or sets the lock history identifiers.

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "amortizationType": "sample String 1",
    "description": "sample String 2",
    "displayOrder": 3,
    "hasDownPaymentAssistance": true,
    "hasIncomeRestrictions": true,
    "internalEnabled": true,
    "isActive": true,
    "isBrokered": true,
    "isHedgeable": true,
    "isPublic": true,
    "isSubjectToMI": true,
    "minMiLtv": 1.0,
    "nickname": "sample String 11",
    "productCode": "sample String 12",
    "requiresTargetRate": true,
    "state": "sample String 14",
    "tier": 15,
    "term": 16,
    "armTerm": "1",
    "defaultDocumentationType": "17",
    "id": "18",
    "loanProgram": "19",
    "forwardCommitments": [
      1,
      2
    ],
    "specialFeatures": [
      "sample String 1",
      "sample String 2"
    ],
    "lockHistories": [
      "1",
      "2"
    ]
  },
  {
    "amortizationType": "sample String 1",
    "description": "sample String 2",
    "displayOrder": 3,
    "hasDownPaymentAssistance": true,
    "hasIncomeRestrictions": true,
    "internalEnabled": true,
    "isActive": true,
    "isBrokered": true,
    "isHedgeable": true,
    "isPublic": true,
    "isSubjectToMI": true,
    "minMiLtv": 1.0,
    "nickname": "sample String 11",
    "productCode": "sample String 12",
    "requiresTargetRate": true,
    "state": "sample String 14",
    "tier": 15,
    "term": 16,
    "armTerm": "1",
    "defaultDocumentationType": "17",
    "id": "18",
    "loanProgram": "19",
    "forwardCommitments": [
      1,
      2
    ],
    "specialFeatures": [
      "sample String 1",
      "sample String 2"
    ],
    "lockHistories": [
      "1",
      "2"
    ]
  }
]

text/html

Sample:
[{"amortizationType":"sample String 1","description":"sample String 2","displayOrder":3,"hasDownPaymentAssistance":true,"hasIncomeRestrictions":true,"internalEnabled":true,"isActive":true,"isBrokered":true,"isHedgeable":true,"isPublic":true,"isSubjectToMI":true,"minMiLtv":1.0,"nickname":"sample String 11","productCode":"sample String 12","requiresTargetRate":true,"state":"sample String 14","tier":15,"term":16,"armTerm":"1","defaultDocumentationType":"17","id":"18","loanProgram":"19","forwardCommitments":[1,2],"specialFeatures":["sample String 1","sample String 2"],"lockHistories":["1","2"]},{"amortizationType":"sample String 1","description":"sample String 2","displayOrder":3,"hasDownPaymentAssistance":true,"hasIncomeRestrictions":true,"internalEnabled":true,"isActive":true,"isBrokered":true,"isHedgeable":true,"isPublic":true,"isSubjectToMI":true,"minMiLtv":1.0,"nickname":"sample String 11","productCode":"sample String 12","requiresTargetRate":true,"state":"sample String 14","tier":15,"term":16,"armTerm":"1","defaultDocumentationType":"17","id":"18","loanProgram":"19","forwardCommitments":[1,2],"specialFeatures":["sample String 1","sample String 2"],"lockHistories":["1","2"]}]

application/vnd.api+json

Sample:

Sample not available.