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 21 Next »

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V1.0

Mar 29, 2024

Que Nguyen

  • Add Table of Contents.

  • Add Changelogs.

API Definition

Create Retirement Application

Resource information

Response format(s)

JSON

Requires authentication?

Yes using token

Request Header

Name

Value

Content-Type

application/json

Authorization

{{token}}

Request Body

DeviceId

  • require

  • string

Unique device identifier

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 (max length 500 character)

BeneficiatyId

  • require

  • uuid

Beneficiary Unique identifier

Returns

Returns Rec Retirement Application Id

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

Id

uuid

 Beneficiary Unique Identifier

Request

POST/public/v2/retirement-applications

Request Payload

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

Response

200 Success

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

400 BadRequest

{
  "Data": null
  "StatusCode": 400,
  "Errors": null,
  "Meta": null,
  "Message": "BadRequest"
}

401 Unauthorized

{
  "Data": null
  "Errors": null,
  "Meta": null,
  "StatusCode": 401,
  "Message": "Unauthorized"
}
  • No labels