Create Retirement Application
Resource information | ||
|---|---|---|
Response format(s) | JSON | |
Requires authentication? | Yes using API token | |
Request Header | ||
Name | Value | |
|
| |
|
| |
Request Body | ||
|
| Unique device identifiers from orders with a status of “completed” |
|
| Quantity <= Number of RECs of Device |
|
| Vintage Year of RECs of Device |
|
| Reason for retirement (max length 500 character) |
|
| Beneficiary Unique identifier |
Returns | ||
Returns Rec Retirement Application Id | ||
Response Header | ||
|---|---|---|
|
| |
Response Body | ||
Field | Type | Description |
|
| Beneficiary Unique Identifier |
Request
| Status | ||||
|---|---|---|---|---|
|
Request Payload
| Code Block | ||
|---|---|---|
| ||
{
"BeneficiatyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
"DeviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Vintage": 2023,
"Quantity": 10,
"Reason": "string",
} |
Response
| Info |
|---|
200 Success |
| Code Block | ||
|---|---|---|
| ||
{
"Data": {
"Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"StatusCode": 200,
"Message": "Success"
} |
| Warning |
|---|
400 BadRequest |
| Code Block | ||
|---|---|---|
| ||
{
"Data": null
"StatusCode": 400,
"Message": "BadRequest"
} |
| Warning |
|---|
401 Unauthorized |
| Code Block | ||
|---|---|---|
| ||
{
"Data": null
"StatusCode": 401,
"Message": "Unauthorized"
} |