GET api/AwardRecognition/GetProspectiveAwardDetails?userId={userId}&awardLevel={awardLevel}&discountCode={discountCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | string |
Required |
|
| awardLevel | string |
Required |
|
| discountCode | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
ProspectiveAwardResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductName | string |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| ProductAmount | decimal number |
None. |
|
| TotalAmount | decimal number |
None. |
|
| ApplicationType | string |
None. |
|
| RenewalType | string |
None. |
|
| FinalAmountToBePaid | decimal number |
None. |
|
| PriceBreakdown | Collection of PriceResponseModel |
None. |
|
| BaseInstalmentAmountString | string |
None. |
|
| Result | ResponseResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"ProductName": "sample string 1",
"StartDate": "2025-11-02T01:07:58.6554411+11:00",
"EndDate": "2025-11-02T01:07:58.6554411+11:00",
"ProductAmount": 1.0,
"TotalAmount": 2.0,
"ApplicationType": "sample string 3",
"RenewalType": "sample string 4",
"FinalAmountToBePaid": 1.0,
"PriceBreakdown": [
{
"Amount": 1.0,
"FeeType": "sample string 2",
"Id": "sample string 3"
},
{
"Amount": 1.0,
"FeeType": "sample string 2",
"Id": "sample string 3"
}
],
"BaseInstalmentAmountString": "sample string 5",
"Result": {
"Success": true,
"Message": "sample string 2",
"Errors": [
{
"Message": "sample string 1"
},
{
"Message": "sample string 1"
}
]
}
}
application/xml, text/xml
Sample:
<ProspectiveAwardResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
<Result>
<Errors>
<ErrorMessage>
<Message>sample string 1</Message>
</ErrorMessage>
<ErrorMessage>
<Message>sample string 1</Message>
</ErrorMessage>
</Errors>
<Message>sample string 2</Message>
<Success>true</Success>
</Result>
<ApplicationType>sample string 3</ApplicationType>
<BaseInstalmentAmountString>sample string 5</BaseInstalmentAmountString>
<EndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-11-01T14:07:58.6554411Z</d2p1:DateTime>
<d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
</EndDate>
<FinalAmountToBePaid>1</FinalAmountToBePaid>
<PriceBreakdown>
<PriceResponseModel>
<Amount>1</Amount>
<FeeType>sample string 2</FeeType>
<Id>sample string 3</Id>
</PriceResponseModel>
<PriceResponseModel>
<Amount>1</Amount>
<FeeType>sample string 2</FeeType>
<Id>sample string 3</Id>
</PriceResponseModel>
</PriceBreakdown>
<ProductAmount>1</ProductAmount>
<ProductName>sample string 1</ProductName>
<RenewalType>sample string 4</RenewalType>
<StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-11-01T14:07:58.6554411Z</d2p1:DateTime>
<d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
</StartDate>
<TotalAmount>2</TotalAmount>
</ProspectiveAwardResponseModel>