POST api/SaveSimulation
Generates the desired withdrawal simulation
Request Information
URI Parameters
None.
Body Parameters
SimulationData| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | string |
None. |
|
| UserName | string |
None. |
|
| ClientId | string |
None. |
|
| SimulationAnswer | Collection of SimulationAnswer |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "sample string 1",
"UserName": "sample string 2",
"ClientId": "sample string 3",
"SimulationAnswer": [
{
"IdEscenario": 1,
"IdSimulacion": 2,
"IdDato": 3,
"DecimalValue": 1.0,
"StringValue": "sample string 4",
"DateValue": "2026-05-16T13:07:26.6704713-05:00",
"BoolValue": true
},
{
"IdEscenario": 1,
"IdSimulacion": 2,
"IdDato": 3,
"DecimalValue": 1.0,
"StringValue": "sample string 4",
"DateValue": "2026-05-16T13:07:26.6704713-05:00",
"BoolValue": true
}
]
}
application/xml, text/xml
Sample:
<SimulationData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SkCo.MyRetirementSimulator.Public.Entities">
<ClientId>sample string 3</ClientId>
<SimulationAnswer>
<SimulationAnswer>
<BoolValue>true</BoolValue>
<DateValue>2026-05-16T13:07:26.6704713-05:00</DateValue>
<DecimalValue>1</DecimalValue>
<IdDato>3</IdDato>
<IdEscenario>1</IdEscenario>
<IdSimulacion>2</IdSimulacion>
<StringValue>sample string 4</StringValue>
</SimulationAnswer>
<SimulationAnswer>
<BoolValue>true</BoolValue>
<DateValue>2026-05-16T13:07:26.6704713-05:00</DateValue>
<DecimalValue>1</DecimalValue>
<IdDato>3</IdDato>
<IdEscenario>1</IdEscenario>
<IdSimulacion>2</IdSimulacion>
<StringValue>sample string 4</StringValue>
</SimulationAnswer>
</SimulationAnswer>
<UserId>sample string 1</UserId>
<UserName>sample string 2</UserName>
</SimulationData>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
MyRetirementResponse| Name | Description | 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:07:26.6704713-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:07:26.6704713-05:00</RedemptionDate> </MyRetirementResponse>