Logbook Student side templates and endpoints

logbook_temaplates_and_endpoints.md

Example of current templates:

• http://elentra-1x-me.localhost/logbook#/logbook: List the clinical courses and their objectives List the entries added by the student for each objective and it progress status.

• http://elentra-1x-me.localhost/logbook#/logbook/log-entry: Shows the form where entries can created for multiple objectives at once.

Endpoints:

• Template http://elentra-1x-me.localhost/logbook#/logbook:

  • List courses:
    • GET /api/v2/logbook/courses
  • List objective parents:
    • GET /api/v2/logbook/courses/{selected_course_id}/objective-parents
  • For each parent list child objectives:
    • GET /api/v2/logbook/courses/76/objectives?parent-id={parent_id} This comes it the entries to be listed with the objective. If it returns no children, the parent itself will have entries related to it
  • View details of a listed entry:
    • List age ranges to be select in the form:
      • GET /api/v2/logbook/age-ranges
    • Seach for perceptors/observers:
      • GET /api/v2/logbook/observers/users?search={search_text}
  • Edit a listed entry:
    • PUT /api/v2/logbook/entries/{entry_id}
  • Delete a listed entry:
    • DELETE /api/v2/logbook/entries/{entry_id}

• Template http://elentra-1x-me.localhost/logbook#/logbook/log-entry:

  • List courses/rotations to be selected in the form:
    • GET /api/v2/logbook/courses
  • List age ranges to be select in the form:
    • GET /api/v2/logbook/age-ranges
  • Seach for perceptors/observers:
    • GET /api/v2/logbook/observers/users?search={search_text}
  • Submit the entry form:
    • POST /api/v2/logbook/entries