Chapters API
Purpose: To get the Chapters List
Endpoint:
GET /chapters
Request Details
Request URL:
https://{firebase_id}.cloudfunctions.net/fincurious_cloudAPI/chapters?moduleId={module_id}
Header:
client-id:client123
client-secret:
secret123
Possible operation types:
READ : Get Chapters List
Response JSON Keys
Chapter Id string
Represents the Chapter Id/Name
Sections string
Represents the List of Sections
Possible Errors
INVALID_URL_PATTERN HTTP 404
Please check if the URL trying to access is a correct one
Resolution The request URL specified is incorrect. Specify a valid request URL.
Refer to request
URL section above
CREDENTIAL_MISMATCH HTTP 401
Unauthorized
Resolution The User doesn't have permission to access the data
INTERNAL_ERROR HTTP 500
Internal Server Error
Resolution Unexpected and unhandled exception in the server. Contact support team
INVALID_REQUEST_METHOD HTTP 400
The http request method type is not a valid one
Resolution You have specified an invalid HTTP method to access the API URL. Specify
a valid request method. Refer to endpoints
section above.
Sample Request
curl -X GET "https://{firebase_id}.cloudfunctions.net/fincurious_cloudAPI/chapters?moduleId={module_id}" \ -H "client-id: client123" \ -H "client-secret: secret123"
Sample Response
{ "id": "Chapter 1 : Practical or US Accounting Rule", "section_hours": [0], "section_mcqs": [0], "sections": [ "Intro", "US Accounting Rule", "Assignment 1", "Assignment 2", "Methods and Classification", "Case Study 1", "Case Study 2" ] }, { "id": "Chapter 2 : Company creation and data management", "sections": [ "Introduction", "Case Study", "Assignment" ] }, { "id": "Chapter 3 : Voucher Entries in Tally", "sections": [ "Ledger Grouping", "Case Study", "Assignment" ] }, { "id": "Chapter 4 : Due Entry Concept", "sections": [ "Case Study", "Assignment" ] }, { "id": "Chapter 5 : Finalisation of ledger balances", "sections": [ "Case Study", "Assignment", "Introduction", "Payroll Ledgers", "TDS Finalization" ] }