POST api/MyRetirement

Generates the desired withdrawal simulation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Token	string	None.
BirthDate	date	None.
Gender	string	None.
ValidPerson	boolean	None.
BeneficiaryType	string	None.
BeneficiaryBirthDate	date	None.
BeneficiaryGender	string	None.
BeneficiaryValidPerson	boolean	None.
Ibc	decimal number	None.
IsIntegralSalary	boolean	None.
FirstDateJob	date	None.
TotalWeeks	integer	None.
WeeksRpm	integer	None.
WeeksRais	integer	None.
IndividualAcountAmount	decimal number	None.
DateTransfer	date	None.
DateBase	date	None.
SalaryDateBase	decimal number	None.
InvestmentProfile	integer	None.
BonusValue	decimal number	None.
RetirementAge	integer	None.
DesiredMonthlyIncome	decimal number	None.
CurrentMonthlySavings	decimal number	None.
UniqueSavings	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "BirthDate": "2026-05-16T13:08:13.6330349-05:00",
  "Gender": "sample string 3",
  "ValidPerson": true,
  "BeneficiaryType": "sample string 5",
  "BeneficiaryBirthDate": "2026-05-16T13:08:13.6330349-05:00",
  "BeneficiaryGender": "sample string 7",
  "BeneficiaryValidPerson": true,
  "Ibc": 9.0,
  "IsIntegralSalary": true,
  "FirstDateJob": "2026-05-16T13:08:13.6330349-05:00",
  "TotalWeeks": 12,
  "WeeksRpm": 13,
  "WeeksRais": 14,
  "IndividualAcountAmount": 15.0,
  "DateTransfer": "2026-05-16T13:08:13.6330349-05:00",
  "DateBase": "2026-05-16T13:08:13.6330349-05:00",
  "SalaryDateBase": 18.0,
  "InvestmentProfile": 19,
  "BonusValue": 20.0,
  "RetirementAge": 21,
  "DesiredMonthlyIncome": 22.0,
  "CurrentMonthlySavings": 23.0,
  "UniqueSavings": 24.0
}

application/xml, text/xml

Sample:

<MyRetirementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SkCo.MyRetirementSimulator.Public.Entities">
  <BeneficiaryBirthDate>2026-05-16T13:08:13.6330349-05:00</BeneficiaryBirthDate>
  <BeneficiaryGender>sample string 7</BeneficiaryGender>
  <BeneficiaryType>sample string 5</BeneficiaryType>
  <BeneficiaryValidPerson>true</BeneficiaryValidPerson>
  <BirthDate>2026-05-16T13:08:13.6330349-05:00</BirthDate>
  <BonusValue>20</BonusValue>
  <CurrentMonthlySavings>23</CurrentMonthlySavings>
  <DateBase>2026-05-16T13:08:13.6330349-05:00</DateBase>
  <DateTransfer>2026-05-16T13:08:13.6330349-05:00</DateTransfer>
  <DesiredMonthlyIncome>22</DesiredMonthlyIncome>
  <FirstDateJob>2026-05-16T13:08:13.6330349-05:00</FirstDateJob>
  <Gender>sample string 3</Gender>
  <Ibc>9</Ibc>
  <IndividualAcountAmount>15</IndividualAcountAmount>
  <InvestmentProfile>19</InvestmentProfile>
  <IsIntegralSalary>true</IsIntegralSalary>
  <RetirementAge>21</RetirementAge>
  <SalaryDateBase>18</SalaryDateBase>
  <Token>sample string 1</Token>
  <TotalWeeks>12</TotalWeeks>
  <UniqueSavings>24</UniqueSavings>
  <ValidPerson>true</ValidPerson>
  <WeeksRais>14</WeeksRais>
  <WeeksRpm>13</WeeksRpm>
</MyRetirementRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MyRetirementRequest'.

Response Information

Resource Description

MyRetirementResponse

Name	Type	Additional information
ProjectedMonthlyIncome	decimal number	None.
CurrentSavingsPercentage	decimal number	None.
MonthlySavingsNeeded	decimal number	None.
RedemptionDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "ProjectedMonthlyIncome": 1.0,
  "CurrentSavingsPercentage": 2.0,
  "MonthlySavingsNeeded": 3.0,
  "RedemptionDate": "2026-05-16T13:08:13.6486411-05:00"
}

application/xml, text/xml

Sample:

<MyRetirementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SkCo.MyRetirementSimulator.Public.Entities">
  <CurrentSavingsPercentage>2</CurrentSavingsPercentage>
  <MonthlySavingsNeeded>3</MonthlySavingsNeeded>
  <ProjectedMonthlyIncome>1</ProjectedMonthlyIncome>
  <RedemptionDate>2026-05-16T13:08:13.6486411-05:00</RedemptionDate>
</MyRetirementResponse>