Cards

The DPP Cards API allows you to manage the lifecycle of DPP cards, including creating, viewing, updating, and deleting them.

A DPP cards allows you to upload text data, as key and value format, to the DPP object.

1. Create DPP Card

POST /create-dpp-card/:dppId

Description: Create a new DPP card for a specific DPP.

Request Body

{
  "name": "string",
  "description": "string",
  "characteristics": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "user_id": "string"
}

Response

Status	Description
200 OK	DPP card created successfully along with its characteristics.
400 Bad Request	Invalid request body or characteristics are not iterable.
500 Internal Server Error	An error occurred while creating the DPP card.

Response Object

{
  "message": "DPP card created successfully",
  "ok": true,
  "dpp_card": {
    "id": "string",
    "dpp_id": "string",
    "name": "string",
    "description": "string",
    "created_at": "string",
    "updated_at": "string",
    "characteristics": [
      {
        "id": "string",
        "dpp_card_id": "string",
        "name": "string",
        "description": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  }
}

2. View DPP Cards

GET /view-dpp-cards/:dppId

Description: Retrieve all DPP cards for a specific DPP.

Response

Status	Description
200 OK	Successfully retrieved the list of DPP cards with their characteristics.
500 Internal Server Error	An error occurred while fetching the DPP cards data.

Response Object

{
  "message": "DPP cards retrieved successfully",
  "ok": true,
  "dpp_cards": [
    {
      "id": "string",
      "dpp_id": "string",
      "name": "string",
      "description": "string",
      "created_at": "string",
      "updated_at": "string",
      "characteristics": [
        {
          "id": "string",
          "dpp_card_id": "string",
          "name": "string",
          "description": "string",
          "created_at": "string",
          "updated_at": "string"
        }
      ]
    }
  ]
}

3. View DPP Card

GET /view-dpp-card/:dppId/:cardId

Description: Retrieve the details of a singular DPP card.

Response

Status	Description
200 OK	Successfully retrieved the DPP card with its characteristics.
406 Not Acceptable	The specified DPP card was not found.
500 Internal Server Error	An error occurred while fetching the DPP card data

Response Object

{
  "message": "DPP card retrieved successfully",
  "ok": true,
  "dpp_card": {
    "id": "string",
    "dpp_id": "string",
    "name": "string",
    "description": "string",
    "created_at": "string",
    "updated_at": "string",
    "characteristics": [
      {
        "id": "string",
        "dpp_card_id": "string",
        "name": "string",
        "description": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  }
}

4. Update DPP Card

PUT /update-dpp-card/:dppId/:cardId

Description: Modify the details of an existing DPP card.

Request Body

{
  "name": "string",
  "description": "string",
  "characteristics": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "user_id": "string"
}

Response

Status	Description
200 OK	DPP card updated successfully with new characteristics.
400 Bad Request	Invalid request body or characteristics are not iterable.
406 Not Acceptable	No DPP cards found to update with the specified ID.
500 Internal Server Error	An error occurred while updating the DPP card or characteristics.

Response Object

{
  "message": "DPP card updated successfully",
  "ok": true,
  "dpp_card": {
    "id": "string",
    "dpp_id": "string",
    "name": "string",
    "description": "string",
    "created_at": "string",
    "updated_at": "string",
    "characteristics": [
      {
        "id": "string",
        "dpp_card_id": "string",
        "name": "string",
        "description": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  }
}

5. Delete DPP Card

DELETE delete-dpp-card/:dppId/:cardId

Description: Delete an existing DPP card.

Response

Status	Description
200 OK	DPP card and its characteristics deleted successfully.
500 Internal Server Error	An unexpected error occurred during the deletion process.

Response Object

{
  "message": "DPP card deleted successfully",
  "ok": true
}