Skip to main content

Update DRAM Document Chapter 2

PATCH 
/documents/:document_id/dram/chapters/2

Update an existing DRAM document chapter 2 (Methodology)

DRAM Chapter 2: Methodology Selection and Criteria

Note: Chapter 2 must be created after Chapter 1. This chapter defines the methodology selection and associated criteria responses for the mitigation action.

Overview​

Chapter 2 captures the methodology applied to the mitigation action and the responses to methodology-specific criteria. Each methodology has its own set of criteria that must be evaluated and documented.

JSON Payload to UI Form Field Mapping​

Methodology Selection​

JSON Payload FieldUI Form FieldTypeRequiredDescription
methodology_idSelected MethodologyUUIDYesThe unique identifier of the methodology selected from the methodology list. This determines which criteria will be evaluated.

Criteria Responses​

The criteria field is an array of criteria response objects. Each methodology has its own predefined set of criteria that must be addressed.

JSON Payload FieldUI Form FieldTypeRequiredDescription
criteria[].criteria_idCriteria IdentifierUUIDYesThe unique identifier of the specific criteria being responded to
criteria[].criteria_textCriteria QuestionStringYesThe text of the criteria question or requirement (read-only, provided by the system)
criteria[].response_textResponse/AnswerStringYesUser's detailed response or explanation addressing the criteria
criteria[].user_idResponding UserUUIDYesThe unique identifier of the user who provided this response
criteria[].updated_atLast UpdatedTimestampYesWhen this criteria response was last modified

Request/Response Examples​

Create Request Body​

{
  "methodology_id": "550e8400-e29b-41d4-a716-446655440000",
  "criteria": [
    {
      "criteria_id": "660e8400-e29b-41d4-a716-446655440001",
      "response_text": "The project implements energy-efficient equipment that reduces emissions by 30%..."
    },
    {
      "criteria_id": "660e8400-e29b-41d4-a716-446655440002",
      "response_text": "Baseline emissions are calculated using the historical average from 2018-2020..."
    }
  ]
}

Update Request Body​

{
  "methodology_id": "550e8400-e29b-41d4-a716-446655440000",
  "criteria": [
    {
      "criteria_id": "660e8400-e29b-41d4-a716-446655440001",
      "response_text": "Updated response: The project implements energy-efficient equipment..."
    }
  ]
}

Get Response​

{
  "request_id": "abc123",
  "data": {
    "methodology": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "category_id": "440e8400-e29b-41d4-a716-446655440000",
      "number": "ACM0001",
      "name": "Consolidated baseline methodology for grid-connected electricity generation from renewable sources",
      "description": "This methodology applies to grid-connected renewable electricity generation...",
      "letter": "A",
      "source": "UNFCCC",
      "is_active": true,
      "external_id": "330e8400-e29b-41d4-a716-446655440000",
      "external_url": "https://cdm.unfccc.int/methodologies/DB/ACM0001"
    },
    "criteria": [
      {
        "criteria_id": "660e8400-e29b-41d4-a716-446655440001",
        "criteria_text": "Does the project activity reduce greenhouse gas emissions?",
        "response_text": "The project implements energy-efficient equipment that reduces emissions by 30%...",
        "user_id": "770e8400-e29b-41d4-a716-446655440000",
        "updated_at": "2025-12-14T12:30:45Z"
      },
      {
        "criteria_id": "660e8400-e29b-41d4-a716-446655440002",
        "criteria_text": "How are baseline emissions calculated?",
        "response_text": "Baseline emissions are calculated using the historical average from 2018-2020...",
        "user_id": "770e8400-e29b-41d4-a716-446655440000",
        "updated_at": "2025-12-14T12:31:20Z"
      }
    ]
  }
}

Validation Rules​

  1. Methodology Selection:

    • The methodology_id must reference an existing, active methodology
    • The methodology must be available in the system's methodology list

  2. Criteria Responses:

    • All criteria associated with the selected methodology should be addressed
    • Each response_text should provide sufficient detail to demonstrate compliance
    • Empty or null response texts may be rejected based on criteria importance

  3. Chapter Dependency:

    • Chapter 1 (Mitigation Action) must exist before Chapter 2 can be created
    • The system will validate this dependency during creation

Notes​

  • Changing the methodology_id after creation may require re-evaluation of all criteria responses
  • Custom criteria can be added via the Custom Criteria endpoints
  • The criteria list is determined by the selected methodology and may vary between methodologies
  • All timestamps are in ISO 8601 format with UTC timezone

Request​

Responses​

No Content