Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 14 Next »

Create Retirement Application

Resource information

Response format(s)

JSON

Requires authentication?

Yes using API key

Request Header

Name

Value

Content-Type

application/json

x-api-key

S93Hrwp5w7J9kJRBfFgjAcexLTKvLHBY

Request Body

DeviceId

  • require

  • string

Unique device identifiers from orders with a status of “completed”

Quantity

  • require

  • decimal

Quantity <= Number of RECs of Device

Vintage

  • require

  • int

Vintage Year of RECs of Device

Reason

  • require

  • string

  • max length: 500

Reason for retirement

BeneficiatyId

  • require

  • uuid

Beneficiary Unique identifier

Returns

Returns Rec Retirement Application Id

Response

Field

Type

Description

Id

uuid

 Beneficiary Unique Identifier

Request

POST /rehash/v1/retirement-applications

Request Payload

{
  "BeneficiatyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  "DeviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Vintage": 2023,
  "Quantity": 10,
  "Reason": "string",
}

Response

Success

{
  "Data": {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "StatusCode": 200,
  "Message": "Success"
}

Error

{
  "Data": null
  "StatusCode": 400,
  "Message": "Error message"
}
  • No labels