{"swagger":"2.0","info":{"version":"1.0.1","title":"A1CE API","description":"A1CE API document"},"schemes":["https","http"],"paths":{"/student/identity":{"get":{"tags":["Student"],"summary":"Get Student Information","operationId":"get_student_identity","produces":["application/json"],"parameters":[{"name":"student_id","in":"query","description":"ID of student","required":true,"type":"string"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"student":{"$ref":"#/definitions/Identity"}}}}}}},"/student/cards":{"get":{"tags":["Student"],"summary":"Get Student Cards","operationId":"get_student_card","produces":["application/json"],"parameters":[{"name":"student_id","in":"query","description":"ID of student","required":true,"type":"string"},{"name":"subdomain_id","in":"query","description":"ID of subdomain","type":"string"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"cards":{"type":"array","description":"List of Student Card","items":{"$ref":"#/definitions/Card"}}}}}}}},"/roadmap/milestones":{"get":{"tags":["Roadmap"],"summary":"Get Student Roadmap","operationId":"get_roadmap","produces":["application/json"],"parameters":[{"name":"year","in":"query","description":"Roadmap year","required":true,"type":"integer"},{"name":"semester","in":"query","description":"Roadmap semester","required":true,"type":"string"},{"name":"student_id","in":"query","description":"Student ID","type":"string"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"roadmaps":{"type":"array","description":"List of roadmap","items":{"$ref":"#/definitions/Roadmap"}}}}}}}},"/subdomain":{"get":{"tags":["Subdomain"],"summary":"Get Pillar with Subdomains","operationId":"get_subdomain","produces":["application/json"],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"pillars":{"type":"array","description":"List of pillar","items":{"$ref":"#/definitions/Pillar"}}}}}}}},"/subdomain/core":{"get":{"tags":["Subdomain"],"summary":"Get Core Pillar with Subdomains","operationId":"get_core_subdomain","produces":["application/json"],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"pillars":{"type":"array","description":"List of pillar","items":{"$ref":"#/definitions/Pillar"}}}}}}}},"/competency":{"get":{"tags":["Competency"],"summary":"Get Competency Information","operationId":"get_competency","produces":["application/json"],"parameters":[{"name":"subdomain_id","in":"query","description":"Subdomain ID","required":true,"type":"string"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"competencies":{"type":"array","description":"List of competency","items":{"$ref":"#/definitions/Competency"}}}}}}}},"/calendar/events":{"get":{"tags":["Calendar"],"summary":"Get Calendar Events","operationId":"get_calendar_event","produces":["application/json"],"parameters":[{"name":"start_date","in":"query","description":"Start date","required":true,"type":"string","format":"date"},{"name":"end_date","in":"query","description":"End date","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"Successful operation","schema":{"type":"object","properties":{"events":{"type":"array","description":"List of event","items":{"$ref":"#/definitions/Event"}}}}}}}}},"definitions":{"Identity":{"type":"object","description":"Student Identity Information","properties":{"id":{"type":"string","description":"Student ID"},"first_name":{"type":"string","description":"Student firstname"},"last_name":{"type":"string","description":"Student lastname"},"nickname":{"type":"string","description":"Student nickname"},"first_term":{"type":"string","description":"Student first term"},"last_term":{"type":"string","description":"Student last term"},"cmkl_id":{"type":"string","description":"Student CMKL ID"},"advisor":{"type":"string","description":"Student advisor"}}},"Card":{"type":"object","description":"Student Card Information","properties":{"id":{"type":"string","description":"Card ID"},"template_id":{"type":"string","description":"Related template ID"},"title":{"type":"string","description":"Card title"},"description":{"type":"string","description":"Card description"},"required":{"type":"boolean","description":"Is card required?"},"credits":{"type":"integer","description":"Card credit"},"status_val":{"type":"integer","description":"Numeric status from the DB"},"status":{"type":"string","description":"Status of card (selected, in progress, completed, abandoned)"},"mastery_level":{"type":"integer","description":"Mastery level, only for completed cards"},"total_skills":{"type":"integer","description":"Number of total skills required"},"assessed_skills":{"type":"integer","description":"Number of assessed skills"},"skills":{"type":"array","description":"All skills associated with the competency","items":{"$ref":"#/definitions/Skill"}}}},"Skill":{"type":"object","description":"Student Skill Information","properties":{"id":{"type":"string","description":"Skill ID"},"title":{"type":"string","description":"Skill title"},"description":{"type":"string","description":"Skill description"},"required":{"type":"boolean","description":"Is skill required?"},"assessment":{"$ref":"#/definitions/Assessment"}}},"Assessment":{"type":"object","description":"Student Assessment Information","properties":{"id":{"type":"string","description":"Assessment ID"},"title":{"type":"string","description":"Assessment title"},"description":{"type":"string","description":"Assessment description"},"result":{"type":"integer","description":"only for assessments that have already been or 0 if not yet assessed"},"assessment_time":{"type":"string","description":"timestamp, only for assessments that have already been done"},"external_url":{"type":"string","description":"URL for more details of assignment"}}},"Roadmap":{"type":"object","description":"Roadmap Information","properties":{"id":{"type":"string","description":"Roadmap ID"},"year":{"type":"integer","description":"Year, western style"},"semester":{"type":"string","description":"Semester (“Spring”, “Summer” or “Fall”)"},"student":{"type":"string","description":"Student ID, may be omitted, in which case this is a “template” roadmap"},"credits":{"type":"integer","description":"Number of Credits"},"milestones":{"type":"array","description":"List of milestones","items":{"$ref":"#/definitions/Milestone"}}}},"Milestone":{"type":"object","description":"Milestone Information","properties":{"id":{"type":"string","description":"Milestone ID"},"title":{"type":"string","description":"Milestone Title"},"description":{"type":"string","description":"Milestone description"},"status_val":{"type":"integer","description":"Numeric status from the DB"},"status":{"type":"string","description":"Will be “Active” for all milestones, for a new roadmap"},"created":{"type":"string","format":"date-time","description":"Date/time creation"},"start_date":{"type":"string","format":"date-time","description":"Date/time creation"},"target_completion_date":{"type":"string","format":"date","description":"Expected completion date"},"actual_completion_date":{"type":"string","format":"date","description":"Actual completion date, empty if not completed"},"competency_card":{"$ref":"#/definitions/Card"}}},"Pillar":{"type":"object","description":"Pillar Information","properties":{"id":{"type":"integer","description":"Pillar ID"},"title":{"type":"string","description":"Pillar title"},"description":{"type":"string","description":"Pillar description"},"code":{"type":"string","description":"Pillar abbreviation"},"is_core":{"type":"boolean","description":"Is it a pillar core?"},"subdomains":{"type":"array","description":"Array of subdomain with information","items":{"$ref":"#/definitions/Subdomain"}},"graphics":{"$ref":"#/definitions/Graphics"}}},"Subdomain":{"type":"object","description":"Subdomain Information","properties":{"id":{"type":"string","description":"Subdomain ID"},"title":{"type":"string","description":"Subdomain title"},"description":{"type":"string","description":"Subdomain description"},"knowledge_areas":{"type":"array","description":"Array of knowledge area","items":{"$ref":"#/definitions/KnowledgeArea"}}}},"KnowledgeArea":{"type":"object","description":"Knowledge Area Information","properties":{"id":{"type":"string","description":"Knowledge area ID"},"title":{"type":"string","description":"Knowledge area title"},"description":{"type":"string","description":"Knowledge area description"}}},"Graphics":{"type":"object","description":"Pillar Graphic Information","properties":{"iconbg":{"type":"string","description":"Icon background color"},"bordercolor":{"type":"string","description":"Icon border color"},"icon":{"type":"string","description":"Icon name"},"iconshadow":{"type":"string","description":"Icon shadow"}}},"Competency":{"type":"object","description":"Competency information","properties":{"id":{"type":"string","description":"Competency ID"},"title":{"type":"string","description":"Competency title"},"description":{"type":"string","description":"Competency description"},"required":{"type":"boolean","description":"Is card required?"},"credits":{"type":"integer","description":"Card credit"},"min_optional":{"type":"integer"},"skills":{"type":"array","description":"All skills associated with the competency","items":{"$ref":"#/definitions/CompetencySkill"}}}},"CompetencySkill":{"type":"object","description":"Skill information","properties":{"id":{"type":"string","description":"Skill ID"},"title":{"type":"string","description":"Skill title"},"description":{"type":"string","description":"Skill description"},"required":{"type":"boolean","description":"Is skill required?"},"assessment":{"$ref":"#/definitions/CompetencyAssessment"}}},"CompetencyAssessment":{"type":"object","description":"Assessment information","properties":{"id":{"type":"string","description":"Assessment ID"},"title":{"type":"string","description":"Assessment title"},"description":{"type":"string","description":"Assessment description"},"external_url":{"type":"string","description":"URL for more details of assignment"}}},"Event":{"type":"object","description":"Event information","properties":{"id":{"type":"string","description":"Event ID"},"title":{"type":"string","description":"Event title"},"description":{"type":"string","description":"Event description"},"event_type_val":{"type":"integer","description":"Numeric event type"},"event_type":{"type":"string","description":"Event type as text"},"responsible_person":{"type":"string","description":"Name of person responsible, optional"},"location":{"type":"string","description":"Event location"},"date":{"type":"string","format":"date","description":"Event date (yyyy-mm-dd)"},"start_time":{"type":"string","format":"time","description":"Event start time (hh:mm, 24 hour time)"},"end_time":{"type":"string","format":"time","description":"Event end time (hh:mm, 24 hour time)"},"url":{"type":"string","description":"URL for more detail"},"url_label":{"type":"string","description":"URL description (e.g. “Zoom Link”, “Register here”)"},"related_competencies":{"type":"array","description":"All related competencies","items":{"$ref":"#/definitions/RelatedCompetency"}}}},"RelatedCompetency":{"type":"object","description":"Related competency information","properties":{"id":{"type":"string","description":"Competency template ID"},"title":{"type":"string","description":"Competency title"},"description":{"type":"string","description":"Competency description"}}}},"host":"virtserver.swaggerhub.com","basePath":"/A1CE/a1ce/1.0.1"}