ASP.NET Web API Help Page

GET nano/government-loan-person-details?appId={appId}&personId={personId}

Retrieves all government loan person details associated with the account.

Request Information

URI Parameters

Name	Description	Type	Additional information
appId	The application identifier.	integer	None.
personId	The person identifier.	integer	None.

Body Parameters

None.

Response Information

Resource Description

A list of government loan person details.

Collection of Nano.GovernmentLoanPersonDetail

Name	Description	Type	Additional information
caivrsNumber	Gets or sets the CAIVRS number.	string	None.
federalIncomeTaxAmount	Gets or sets the federal income tax amount.	decimal number	None.
hadPreviousVaLoan	Gets or sets a value indicating whether the person had a previous VA loan.	boolean	None.
hasExistingVaLoan	Gets or sets a value indicating whether it has an existing VA loan.	boolean	None.
incomeGrossUpAmount	Gets or sets the income gross up amount.	decimal number	None.
incomeGrossUpDescription	Gets or sets the income gross up description.	string	None.
isApplyingForRestorationOfEntitlement	Gets or sets a value indicating whether it is applying for restoration of entitlement.	boolean	None.
isVaDisabled	Gets or sets a value indicating whether it is VA disabled.	boolean	None.
socialSecurityTaxAmount	Gets or sets the social security tax amount.	decimal number	None.
soldFormerVaProperty	Gets or sets the sold former VA property.	boolean	None.
stateIncomeTaxAmount	Gets or sets the state income tax amount.	decimal number	None.
subjectPropertyHasVaLoan	Gets or sets the subject property has VA loan.	boolean	None.
id	Gets or sets the government loan person detail identifier.	integer	None.
person	Gets or sets the person identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "caivrsNumber": "sample String 1",
    "federalIncomeTaxAmount": 1.0,
    "hadPreviousVaLoan": true,
    "hasExistingVaLoan": true,
    "incomeGrossUpAmount": 1.0,
    "incomeGrossUpDescription": "sample String 2",
    "isApplyingForRestorationOfEntitlement": true,
    "isVaDisabled": true,
    "socialSecurityTaxAmount": 1.0,
    "soldFormerVaProperty": true,
    "stateIncomeTaxAmount": 1.0,
    "subjectPropertyHasVaLoan": true,
    "id": "4",
    "person": "5"
  },
  {
    "caivrsNumber": "sample String 1",
    "federalIncomeTaxAmount": 1.0,
    "hadPreviousVaLoan": true,
    "hasExistingVaLoan": true,
    "incomeGrossUpAmount": 1.0,
    "incomeGrossUpDescription": "sample String 2",
    "isApplyingForRestorationOfEntitlement": true,
    "isVaDisabled": true,
    "socialSecurityTaxAmount": 1.0,
    "soldFormerVaProperty": true,
    "stateIncomeTaxAmount": 1.0,
    "subjectPropertyHasVaLoan": true,
    "id": "4",
    "person": "5"
  }
]

text/html

Sample:

[{"caivrsNumber":"sample String 1","federalIncomeTaxAmount":1.0,"hadPreviousVaLoan":true,"hasExistingVaLoan":true,"incomeGrossUpAmount":1.0,"incomeGrossUpDescription":"sample String 2","isApplyingForRestorationOfEntitlement":true,"isVaDisabled":true,"socialSecurityTaxAmount":1.0,"soldFormerVaProperty":true,"stateIncomeTaxAmount":1.0,"subjectPropertyHasVaLoan":true,"id":"4","person":"5"},{"caivrsNumber":"sample String 1","federalIncomeTaxAmount":1.0,"hadPreviousVaLoan":true,"hasExistingVaLoan":true,"incomeGrossUpAmount":1.0,"incomeGrossUpDescription":"sample String 2","isApplyingForRestorationOfEntitlement":true,"isVaDisabled":true,"socialSecurityTaxAmount":1.0,"soldFormerVaProperty":true,"stateIncomeTaxAmount":1.0,"subjectPropertyHasVaLoan":true,"id":"4","person":"5"}]

application/xml, text/xml

Sample:

<ArrayOfGovernmentLoanPersonDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GovernmentLoanPersonDetail>
    <CAIVRSNumber>sample String 1</CAIVRSNumber>
    <FederalIncomeTaxAmount>1</FederalIncomeTaxAmount>
    <HadPreviousVALoan>true</HadPreviousVALoan>
    <HasExistingVALoan>true</HasExistingVALoan>
    <IncomeGrossUpAmount>1</IncomeGrossUpAmount>
    <IncomeGrossUpDescription>sample String 2</IncomeGrossUpDescription>
    <IsApplyingForRestorationOfEntitlement>true</IsApplyingForRestorationOfEntitlement>
    <IsVADisabled>true</IsVADisabled>
    <SocialSecurityTaxAmount>1</SocialSecurityTaxAmount>
    <SoldFormerVAProperty>true</SoldFormerVAProperty>
    <StateIncomeTaxAmount>1</StateIncomeTaxAmount>
    <SubjectPropertyHasVALoan>true</SubjectPropertyHasVALoan>
    <GovernmentLoanPersonDetailId>4</GovernmentLoanPersonDetailId>
    <PersonId>5</PersonId>
  </GovernmentLoanPersonDetail>
  <GovernmentLoanPersonDetail>
    <CAIVRSNumber>sample String 1</CAIVRSNumber>
    <FederalIncomeTaxAmount>1</FederalIncomeTaxAmount>
    <HadPreviousVALoan>true</HadPreviousVALoan>
    <HasExistingVALoan>true</HasExistingVALoan>
    <IncomeGrossUpAmount>1</IncomeGrossUpAmount>
    <IncomeGrossUpDescription>sample String 2</IncomeGrossUpDescription>
    <IsApplyingForRestorationOfEntitlement>true</IsApplyingForRestorationOfEntitlement>
    <IsVADisabled>true</IsVADisabled>
    <SocialSecurityTaxAmount>1</SocialSecurityTaxAmount>
    <SoldFormerVAProperty>true</SoldFormerVAProperty>
    <StateIncomeTaxAmount>1</StateIncomeTaxAmount>
    <SubjectPropertyHasVALoan>true</SubjectPropertyHasVALoan>
    <GovernmentLoanPersonDetailId>4</GovernmentLoanPersonDetailId>
    <PersonId>5</PersonId>
  </GovernmentLoanPersonDetail>
</ArrayOfGovernmentLoanPersonDetail>

application/vnd.api+json

Sample:

Sample not available.