Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of arm terms.

Collection of Pico.ARMTerm
NameDescriptionTypeAdditional information
adjustmentPeriod

Gets or sets the adjustment period.

 integer

None.
description

Gets or sets the description.

 string

None.
duPlanCode

Gets or sets the du plan code.

 string

None.
fixedPeriod

Gets or sets the fixed period.

 integer

None.
initialAdjustmentCap

Gets or sets the initial adjustment cap.

 integer

None.
isActive

Gets or sets the is active.

 boolean

None.
lifetimeCap

Gets or sets the lifetime cap.

 integer

None.
margin

Gets or sets the margin.

 decimal number

None.
periodicAdjustmentCap

Gets or sets the periodic adjustment cap.

 integer

None.
qualifyingRateAdjustment

Gets or sets the qualifying rate adjustment.

 decimal number

None.
qualifyingRateMethod

Gets or sets the qualifying rate method.

 string

None.
id

Gets or sets the ARM term identifier.

 integer

None.
indexType

Gets or sets the type of the index.

 integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "adjustmentPeriod": 1,
    "description": "sample String 2",
    "duPlanCode": "sample String 3",
    "fixedPeriod": 4,
    "initialAdjustmentCap": 1,
    "isActive": true,
    "lifetimeCap": 1,
    "margin": 1.1,
    "periodicAdjustmentCap": 1,
    "qualifyingRateAdjustment": 1.1,
    "qualifyingRateMethod": "sample String 5",
    "id": "6",
    "indexType": "1"
  },
  {
    "adjustmentPeriod": 1,
    "description": "sample String 2",
    "duPlanCode": "sample String 3",
    "fixedPeriod": 4,
    "initialAdjustmentCap": 1,
    "isActive": true,
    "lifetimeCap": 1,
    "margin": 1.1,
    "periodicAdjustmentCap": 1,
    "qualifyingRateAdjustment": 1.1,
    "qualifyingRateMethod": "sample String 5",
    "id": "6",
    "indexType": "1"
  }
]

text/html

Sample: 
[{"adjustmentPeriod":1,"description":"sample String 2","duPlanCode":"sample String 3","fixedPeriod":4,"initialAdjustmentCap":1,"isActive":true,"lifetimeCap":1,"margin":1.1,"periodicAdjustmentCap":1,"qualifyingRateAdjustment":1.1,"qualifyingRateMethod":"sample String 5","id":"6","indexType":"1"},{"adjustmentPeriod":1,"description":"sample String 2","duPlanCode":"sample String 3","fixedPeriod":4,"initialAdjustmentCap":1,"isActive":true,"lifetimeCap":1,"margin":1.1,"periodicAdjustmentCap":1,"qualifyingRateAdjustment":1.1,"qualifyingRateMethod":"sample String 5","id":"6","indexType":"1"}]

application/xml, text/xml

Sample: 
<ArrayOfARMTerm xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ARMTerm>
    <AdjustmentPeriod>1</AdjustmentPeriod>
    <Description>sample String 2</Description>
    <DUPlanCode>sample String 3</DUPlanCode>
    <FixedPeriod>4</FixedPeriod>
    <InitialAdjustmentCap>1</InitialAdjustmentCap>
    <IsActive>true</IsActive>
    <LifetimeCap>1</LifetimeCap>
    <Margin>1.1</Margin>
    <PeriodicAdjustmentCap>1</PeriodicAdjustmentCap>
    <QualifyingRateAdjustment>1.1</QualifyingRateAdjustment>
    <QualifyingRateMethod>sample String 5</QualifyingRateMethod>
    <ARMTermId>6</ARMTermId>
    <IndexType>1</IndexType>
  </ARMTerm>
  <ARMTerm>
    <AdjustmentPeriod>1</AdjustmentPeriod>
    <Description>sample String 2</Description>
    <DUPlanCode>sample String 3</DUPlanCode>
    <FixedPeriod>4</FixedPeriod>
    <InitialAdjustmentCap>1</InitialAdjustmentCap>
    <IsActive>true</IsActive>
    <LifetimeCap>1</LifetimeCap>
    <Margin>1.1</Margin>
    <PeriodicAdjustmentCap>1</PeriodicAdjustmentCap>
    <QualifyingRateAdjustment>1.1</QualifyingRateAdjustment>
    <QualifyingRateMethod>sample String 5</QualifyingRateMethod>
    <ARMTermId>6</ARMTermId>
    <IndexType>1</IndexType>
  </ARMTerm>
</ArrayOfARMTerm>