API Resources

Approver - Approval Summaries API

Interfaces

Fetch approval summaries

GET /api/approver/approval_summaries

Response Codes

  • 200 OK

Example Response

{
  "approval_summaries": [
    {
      "id": "1",
      "learnable_id": "2",
      "learnable_type": "Task",
      "title": "Sign up for enrollment",
      "description": "how to sign up",
      "pending_count": 1,
      "retry_count": 1,
      "approved_count": 1
    }
  ]
}

Fetch an approval summary

GET /api/approver/approval_summaries/:learnable_type/:learnable_id

Response Codes

  • 200 OK
  • 404 Not Found

Parameters

  • learnable_id Integer Required

    Id of the learnable

  • learnable_type String Required

    Type of the learnable

Example Response

{
  "approval_summaries": [
    {
      "id": "1",
      "learnable_id": "2",
      "learnable_type": "Task",
      "title": "Sign up for enrollment",
      "description": "how to sign up",
      "pending_count": 1,
      "retry_count": 1,
      "approved_count": 1
    }
  ],
  "meta": {
    "next_up_approval_summary": ["ApprovalSummary or nil"]
  }
}