API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Mar 8th, 2017
96
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 51.85 KB | None | 0 0
raw download clone embed print report
  1. swagger: '2.0'
  2. info:
  3. version: ''
  4. title: online school system
  5. description: |-
  6. ## Welcome
  7.  
  8. This is a place to put general notes and extra information, for internal use.
  9.  
  10. To get started designing/documenting this API, select a version on the left. # Title
  11. No Description
  12. host: 'localhost:9000'
  13. basePath: /api/v1
  14. schemes:
  15. - http
  16. consumes:
  17. - application/json
  18. produces:
  19. - application/json
  20. paths:
  21. /students:
  22. get:
  23. summary: Get students
  24. tags:
  25. - students
  26. responses:
  27. '200':
  28. description: ''
  29. schema:
  30. $ref: '#/definitions/students_full'
  31. post:
  32. summary: Create students
  33. tags:
  34. - students
  35. parameters:
  36. - name: body
  37. in: body
  38. schema:
  39. $ref: '#/definitions/students_full'
  40. responses:
  41. '201':
  42. description: ''
  43. schema:
  44. $ref: '#/definitions/students_full'
  45. /hello/{name}:
  46. parameters:
  47. - name: name
  48. in: path
  49. required: true
  50. type: string
  51. get:
  52. summary: Say hello
  53. tags:
  54. - hello
  55. responses:
  56. '200':
  57. description: ''
  58. schema:
  59. $ref: '#/definitions/hello'
  60. /accounts:
  61. get:
  62. summary: Get accounts
  63. tags:
  64. - accounts
  65. responses:
  66. '200':
  67. description: ''
  68. schema:
  69. $ref: '#/definitions/students_full'
  70. post:
  71. summary: Create account
  72. tags:
  73. - accounts
  74. parameters:
  75. - name: body
  76. in: body
  77. schema:
  78. $ref: '#/definitions/accounts_full'
  79. responses:
  80. '201':
  81. description: ''
  82. schema:
  83. type: object
  84. properties:
  85. id:
  86. type: integer
  87. last_name:
  88. type: string
  89. first_name:
  90. type: string
  91. middle_name:
  92. type: string
  93. email:
  94. type: string
  95. gender:
  96. type: string
  97. birth_year:
  98. type: integer
  99. birth_month:
  100. type: integer
  101. birth_day:
  102. type: integer
  103. school_id:
  104. type: integer
  105. school_name:
  106. type: string
  107. type:
  108. type: integer
  109. type_name:
  110. type: string
  111. current_balance:
  112. type: integer
  113. date_created:
  114. type: string
  115. date_updated:
  116. type: string
  117. password:
  118. type: string
  119. examples:
  120. application/json:
  121. id: 1
  122. last_name: Ong
  123. first_name: Miles
  124. middle_name: Nolasco
  125. email: miles.ong@seer_technologies.com
  126. gender: Male
  127. birth_year: 1993
  128. birth_month: 5
  129. birth_day: 10
  130. school_id: 1
  131. school_name: Ateneo de Manila University
  132. type: 4
  133. type_name: Student
  134. current_balance: 10000
  135. date_created: 1/18/2016
  136. date_updated: 7/18/2016
  137. /accounts/{id}:
  138. parameters:
  139. - name: id
  140. in: path
  141. required: true
  142. type: string
  143. put:
  144. summary: Update account
  145. tags:
  146. - accounts
  147. parameters:
  148. - name: body
  149. in: body
  150. schema:
  151. $ref: '#/definitions/accounts_full'
  152. responses:
  153. '200':
  154. description: ''
  155. schema:
  156. type: object
  157. properties:
  158. id:
  159. type: integer
  160. last_name:
  161. type: string
  162. first_name:
  163. type: string
  164. middle_name:
  165. type: string
  166. email:
  167. type: string
  168. gender:
  169. type: string
  170. birth_year:
  171. type: integer
  172. birth_month:
  173. type: integer
  174. birth_day:
  175. type: integer
  176. school_id:
  177. type: integer
  178. school_name:
  179. type: string
  180. type:
  181. type: integer
  182. type_name:
  183. type: string
  184. current_balance:
  185. type: integer
  186. date_created:
  187. type: string
  188. date_updated:
  189. type: string
  190. examples:
  191. application/json:
  192. id: 1
  193. last_name: Ong
  194. first_name: Miles
  195. middle_name: Nolasco
  196. email: miles.ong@seer_technologies.com
  197. gender: Male
  198. birth_year: 1993
  199. birth_month: 5
  200. birth_day: 10
  201. school_id: 1
  202. school_name: Ateneo de Manila University
  203. type: 4
  204. type_name: Student
  205. current_balance: 10000
  206. date_created: 1/18/2016
  207. date_updated: 7/18/2016
  208. delete:
  209. summary: Delete account
  210. tags:
  211. - accounts
  212. responses:
  213. '204':
  214. description: ''
  215. schema:
  216. type: object
  217. get:
  218. summary: Get account by id
  219. tags:
  220. - accounts
  221. responses:
  222. '200':
  223. description: ''
  224. schema:
  225. type: object
  226. properties:
  227. id:
  228. type: integer
  229. last_name:
  230. type: string
  231. first_name:
  232. type: string
  233. middle_name:
  234. type: string
  235. email:
  236. type: string
  237. gender:
  238. type: string
  239. birth_year:
  240. type: integer
  241. birth_month:
  242. type: integer
  243. birth_day:
  244. type: integer
  245. school_id:
  246. type: integer
  247. school_name:
  248. type: string
  249. type:
  250. type: integer
  251. type_name:
  252. type: string
  253. current_balance:
  254. type: integer
  255. date_created:
  256. type: string
  257. date_updated:
  258. type: string
  259. examples:
  260. application/json:
  261. id: 1
  262. last_name: Ong
  263. first_name: Miles
  264. middle_name: Nolasco
  265. email: miles.ong@seer_technologies.com
  266. gender: Male
  267. birth_year: 1993
  268. birth_month: 5
  269. birth_day: 10
  270. school_id: 1
  271. school_name: Ateneo de Manila University
  272. type: 4
  273. type_name: Student
  274. current_balance: 10000
  275. date_created: 1/18/2016
  276. date_updated: 7/18/2016
  277. /login:
  278. post:
  279. parameters:
  280. - name: body
  281. in: body
  282. schema:
  283. $ref: '#/definitions/user_login'
  284. responses:
  285. 200:
  286. description: ''
  287. schema:
  288. $ref: '#/definitions/user_login_response'
  289. /programs:
  290. get:
  291. summary: Get programs
  292. tags:
  293. - programs
  294. responses:
  295. '200':
  296. description: ''
  297. schema:
  298. $ref: '#/definitions/programs_data_get'
  299. post:
  300. summary: Create new programs
  301. tags:
  302. - programs
  303. parameters:
  304. - name: body
  305. in: body
  306. schema:
  307. $ref: '#/definitions/programs_data'
  308. responses:
  309. '200':
  310. description: ''
  311. schema:
  312. type: object
  313. properties:
  314. product_id:
  315. type: integer
  316. product_code:
  317. type: string
  318. title:
  319. type: string
  320. description:
  321. type: string
  322. units:
  323. type: integer
  324. requirements:
  325. type: array
  326. items:
  327. type: object
  328. properties:
  329. course_id:
  330. type: integer
  331. course_code:
  332. type: string
  333. requirement_type:
  334. type: integer
  335. department_id:
  336. type: integer
  337. department_name:
  338. type: string
  339. published_price:
  340. type: integer
  341. product_type:
  342. type: integer
  343. examples:
  344. application/json:
  345. product_id: 0
  346. product_code: string
  347. title: string
  348. description: string
  349. units: 0
  350. requirements:
  351. - course_id: 0
  352. course_code: string
  353. requirement_type: 0
  354. department_id: 0
  355. department_name: string
  356. published_price: 0
  357. product_type: 0
  358. /programs/{id}:
  359. parameters:
  360. - name: id
  361. in: path
  362. required: true
  363. type: string
  364. put:
  365. summary: Update program information.
  366. tags:
  367. - programs
  368. parameters:
  369. - name: body
  370. in: body
  371. schema:
  372. $ref: '#/definitions/programs_data'
  373. responses:
  374. '200':
  375. description: ''
  376. schema:
  377. type: object
  378. properties:
  379. product_id:
  380. type: integer
  381. product_code:
  382. type: string
  383. title:
  384. type: string
  385. description:
  386. type: string
  387. units:
  388. type: integer
  389. requirements:
  390. type: array
  391. items:
  392. type: object
  393. properties:
  394. course_id:
  395. type: integer
  396. course_code:
  397. type: string
  398. requirement_type:
  399. type: integer
  400. department_id:
  401. type: integer
  402. department_name:
  403. type: string
  404. published_price:
  405. type: integer
  406. product_type:
  407. type: integer
  408. examples:
  409. application/json:
  410. product_id: 0
  411. product_code: string
  412. title: string
  413. description: string
  414. units: 0
  415. requirements:
  416. - course_id: 0
  417. course_code: string
  418. requirement_type: 0
  419. department_id: 0
  420. department_name: string
  421. published_price: 0
  422. product_type: 0
  423. get:
  424. summary: Get specific program information
  425. tags:
  426. - programs
  427. responses:
  428. '200':
  429. description: ''
  430. schema:
  431. type: object
  432. properties:
  433. product_id:
  434. type: integer
  435. product_code:
  436. type: string
  437. title:
  438. type: string
  439. description:
  440. type: string
  441. units:
  442. type: integer
  443. requirements:
  444. type: array
  445. items:
  446. type: object
  447. properties:
  448. course_id:
  449. type: integer
  450. course_code:
  451. type: string
  452. requirement_type:
  453. type: integer
  454. department_id:
  455. type: integer
  456. department_name:
  457. type: string
  458. published_price:
  459. type: integer
  460. product_type:
  461. type: integer
  462. examples:
  463. application/json:
  464. product_id: 0
  465. product_code: string
  466. title: string
  467. description: string
  468. units: 0
  469. requirements:
  470. - course_id: 0
  471. course_code: string
  472. requirement_type: 0
  473. department_id: 0
  474. department_name: string
  475. published_price: 0
  476. product_type: 0
  477. delete:
  478. summary: Delete specific program
  479. tags:
  480. - programs
  481. responses:
  482. '204':
  483. description: ''
  484. /programs/{id}/student_count:
  485. parameters:
  486. - name: id
  487. in: path
  488. required: true
  489. type: integer
  490. get:
  491. operationId: 'modules.programs.get_specific_students_count'
  492. summary: Get count of students enrolled.
  493. tags:
  494. - programs
  495. responses:
  496. '200':
  497. description: ''
  498. schema:
  499. type: object
  500. properties:
  501. data:
  502. type: array
  503. items:
  504. type: object
  505. properties:
  506. program:
  507. type: string
  508. student_count:
  509. type: integer
  510. id:
  511. type: integer
  512. /programs/student_count:
  513. get:
  514. operationId: 'modules.programs.get_all_students_count'
  515. summary: Get count of students enrolled.
  516. tags:
  517. - programs
  518. responses:
  519. '200':
  520. description: ''
  521. schema:
  522. type: object
  523. properties:
  524. data:
  525. type: array
  526. items:
  527. type: object
  528. properties:
  529. program:
  530. type: string
  531. student_count:
  532. type: integer
  533. id:
  534. type: integer
  535. /courses:
  536. get:
  537. summary: Get courses
  538. tags:
  539. - courses
  540. responses:
  541. '200':
  542. description: ''
  543. schema:
  544. type: array
  545. items:
  546. type: object
  547. properties:
  548. course_id:
  549. type: integer
  550. course_code:
  551. type: string
  552. title:
  553. type: string
  554. description:
  555. type: string
  556. units:
  557. type: integer
  558. requirements:
  559. type: array
  560. items:
  561. type: object
  562. properties:
  563. course_id:
  564. type: integer
  565. course_code:
  566. type: string
  567. requirement_type:
  568. type: integer
  569. department_id:
  570. type: integer
  571. department_name:
  572. type: string
  573. published_price:
  574. type: integer
  575. product_type:
  576. type: integer
  577. examples:
  578. application/json:
  579. - course_id: 0
  580. course_code: string
  581. title: string
  582. description: string
  583. units: 0
  584. requirements:
  585. - course_id: 0
  586. course_code: string
  587. requirement_type: 0
  588. department_id: 0
  589. department_name: string
  590. published_price: 0
  591. product_type: 0
  592. post:
  593. summary: Create new course
  594. tags:
  595. - courses
  596. parameters:
  597. - name: body
  598. in: body
  599. schema:
  600. $ref: '#/definitions/course_data'
  601. responses:
  602. '200':
  603. description: ''
  604. schema:
  605. type: object
  606. properties:
  607. course_id:
  608. type: integer
  609. course_code:
  610. type: string
  611. title:
  612. type: string
  613. description:
  614. type: string
  615. units:
  616. type: integer
  617. requirements:
  618. type: array
  619. items:
  620. type: object
  621. properties:
  622. course_id:
  623. type: integer
  624. course_code:
  625. type: string
  626. requirement_type:
  627. type: integer
  628. department_id:
  629. type: integer
  630. department_name:
  631. type: string
  632. published_price:
  633. type: integer
  634. product_type:
  635. type: integer
  636. examples:
  637. application/json:
  638. course_id: 0
  639. course_code: string
  640. title: string
  641. description: string
  642. units: 0
  643. requirements:
  644. - course_id: 0
  645. course_code: string
  646. requirement_type: 0
  647. department_id: 0
  648. department_name: string
  649. published_price: 0
  650. product_type: 0
  651. /courses/{id}:
  652. parameters:
  653. - name: id
  654. in: path
  655. required: true
  656. type: string
  657. put:
  658. summary: Update course
  659. tags:
  660. - courses
  661. parameters:
  662. - name: body
  663. in: body
  664. schema:
  665. $ref: '#/definitions/course_data'
  666. responses:
  667. '200':
  668. description: ''
  669. schema:
  670. type: object
  671. properties:
  672. course_id:
  673. type: integer
  674. course_code:
  675. type: string
  676. title:
  677. type: string
  678. description:
  679. type: string
  680. units:
  681. type: integer
  682. requirements:
  683. type: array
  684. items:
  685. type: object
  686. properties:
  687. course_id:
  688. type: integer
  689. course_code:
  690. type: string
  691. requirement_type:
  692. type: integer
  693. department_id:
  694. type: integer
  695. department_name:
  696. type: string
  697. published_price:
  698. type: integer
  699. product_type:
  700. type: integer
  701. examples:
  702. application/json:
  703. course_id: 0
  704. course_code: string
  705. title: string
  706. description: string
  707. units: 0
  708. requirements:
  709. - course_id: 0
  710. course_code: string
  711. requirement_type: 0
  712. department_id: 0
  713. department_name: string
  714. published_price: 0
  715. product_type: 0
  716. get:
  717. summary: Get a particular course
  718. tags:
  719. - courses
  720. responses:
  721. '200':
  722. description: ''
  723. schema:
  724. type: object
  725. properties:
  726. course_id:
  727. type: integer
  728. course_code:
  729. type: string
  730. title:
  731. type: string
  732. description:
  733. type: string
  734. units:
  735. type: integer
  736. requirements:
  737. type: array
  738. items:
  739. type: object
  740. properties:
  741. course_id:
  742. type: integer
  743. course_code:
  744. type: string
  745. requirement_type:
  746. type: integer
  747. department_id:
  748. type: integer
  749. department_name:
  750. type: string
  751. published_price:
  752. type: integer
  753. product_type:
  754. type: integer
  755. examples:
  756. application/json:
  757. course_id: 0
  758. course_code: string
  759. title: string
  760. description: string
  761. units: 0
  762. requirements:
  763. - course_id: 0
  764. course_code: string
  765. requirement_type: 0
  766. department_id: 0
  767. department_name: string
  768. published_price: 0
  769. product_type: 0
  770. delete:
  771. summary: Delete a particular course
  772. tags:
  773. - courses
  774. responses:
  775. '204':
  776. description: ''
  777. /students/{account_id}:
  778. parameters:
  779. - name: account_id
  780. in: path
  781. required: true
  782. type: string
  783. get:
  784. summary: Get student by account id
  785. tags:
  786. - students
  787. responses:
  788. '200':
  789. description: ''
  790. schema:
  791. $ref: '#/definitions/students_full'
  792. put:
  793. summary: Update students
  794. tags:
  795. - students
  796. parameters:
  797. - name: body
  798. in: body
  799. schema:
  800. $ref: '#/definitions/students_full'
  801. responses:
  802. '200':
  803. description: ''
  804. schema:
  805. $ref: '#/definitions/students_full'
  806. delete:
  807. summary: Delete students
  808. tags:
  809. - students
  810. responses:
  811. '204':
  812. description: ''
  813. schema:
  814. type: object
  815. properties:
  816. status:
  817. type: integer
  818. error:
  819. type: string
  820. examples:
  821. application/json:
  822. - status: 0
  823. - status: -1
  824. error: Unknown error.
  825. /students/{account_id}/application:
  826. parameters:
  827. - name: account_id
  828. in: path
  829. required: true
  830. type: string
  831. get:
  832. operationId: 'modules.students.get_applications'
  833. summary: Show student's pending / approved applications
  834. tags:
  835. - students
  836. responses:
  837. '200':
  838. description: ''
  839. schema:
  840. $ref: '#/definitions/show_applications'
  841. post:
  842. parameters:
  843. - name: body
  844. in: body
  845. schema:
  846. $ref: '#/definitions/apply_applications'
  847. operationId: 'modules.students.apply_programs'
  848. summary: Student applies for 1-3 programs
  849. tags:
  850. - students
  851. responses:
  852. '201':
  853. description: ''
  854. /students/{account_id}/classes:
  855. parameters:
  856. - name: account_id
  857. in: path
  858. required: true
  859. type: string
  860. get:
  861. operationId: 'modules.students.get_student_currently_enrolled_classes'
  862. summary: Get a student's currently enrolled classes
  863. tags:
  864. - students
  865. responses:
  866. '200':
  867. description: ''
  868. schema:
  869. type: object
  870. properties:
  871. account_id:
  872. type: integer
  873. current_period:
  874. type: string
  875. current_classes:
  876. type: array
  877. items:
  878. type: object
  879. properties:
  880. course_id:
  881. type: integer
  882. course_code:
  883. type: string
  884. offering_id:
  885. type: integer
  886. units:
  887. type: integer
  888. grade:
  889. type: integer
  890. course_accomplishment:
  891. type: string
  892. examples:
  893. application/json:
  894. account_id: 0
  895. current_period: string
  896. current_classes:
  897. - course_id: 0
  898. course_code: string
  899. offering_id: 0
  900. units: 3
  901. grade: 0
  902. course_accomplishment: Incomplete
  903. /students/{account_id}/gwa/{term_id}:
  904. parameters:
  905. - name: term_id
  906. in: path
  907. required: true
  908. type: string
  909. - name: account_id
  910. in: path
  911. required: true
  912. type: string
  913. get:
  914. operationId: 'modules.students.get_gwa'
  915. summary: 'Get student general weighted average for a specific term'
  916. tags:
  917. - students
  918. responses:
  919. '200':
  920. description: ''
  921. schema:
  922. $ref: '#/definitions/students_gwa'
  923. /students/{account_id}/transcripts:
  924. parameters:
  925. - name: account_id
  926. in: path
  927. required: true
  928. type: string
  929. get:
  930. operationId: 'modules.students.get_transcripts'
  931. summary: Get student's transcripts
  932. tags:
  933. - courses
  934. responses:
  935. '200':
  936. description: ''
  937. schema:
  938. type: object
  939. properties:
  940. account_id:
  941. type: integer
  942. transcripts:
  943. type: array
  944. items:
  945. type: object
  946. properties:
  947. course_id:
  948. type: integer
  949. course_code:
  950. type: string
  951. period_offered:
  952. type: string
  953. units:
  954. type: integer
  955. grade:
  956. type: number
  957. course_accomplishment:
  958. type: string
  959. examples:
  960. application/json:
  961. account_id: 0
  962. transcript:
  963. - course_id: 1
  964. course_code: FIL11
  965. period_offered: 2016-1
  966. units: 3
  967. grade: 0
  968. course_accomplishment: Incomplete
  969. '/teachers/offerings':
  970. get:
  971. operationId: 'modules.teachers.offerings_all'
  972. summary: Assign a course to teacher / mentor
  973. tags:
  974. - teachers
  975. responses:
  976. '200':
  977. description: 'Teacher assign to a course'
  978. schema:
  979. $ref: '#/definitions/teacher_products_matching'
  980. '/teachers/{account_id}/offerings':
  981. parameters:
  982. - name: account_id
  983. in: path
  984. required: true
  985. type: string
  986. get:
  987. operationId: 'modules.teachers.offerings_teacher'
  988. summary: Get a student's currently enrolled classes
  989. tags:
  990. - teachers
  991. responses:
  992. '200':
  993. description: 'Teacher assign to a course'
  994. schema:
  995. $ref: '#/definitions/teacher_products_matching'
  996. post:
  997. operationId: 'modules.teachers.assign_course'
  998. summary: Assign a course to teacher / mentor
  999. tags:
  1000. - teachers
  1001. parameters:
  1002. - name: body
  1003. in: body
  1004. schema:
  1005. $ref: '#/definitions/teacher_course_assign'
  1006. responses:
  1007. '204':
  1008. description: 'Teacher assign to a course'
  1009. '/teachers/{account_id}/offerings/{product_id}':
  1010. parameters:
  1011. - name: account_id
  1012. in: path
  1013. required: true
  1014. type: string
  1015. - name: product_id
  1016. in: path
  1017. required: true
  1018. type: string
  1019. delete:
  1020. operationId: 'modules.teachers.retract_course'
  1021. summary: Retract assigned course to a teacher
  1022. tags:
  1023. - teachers
  1024. responses:
  1025. '204':
  1026. description: ''
  1027. /students/students_count_location:
  1028. get:
  1029. operationId: 'modules.students.students_loc_distribution'
  1030. summary: Get students count by location
  1031. tags:
  1032. - students
  1033. responses:
  1034. '200':
  1035. description: ''
  1036. schema:
  1037. type: object
  1038. properties:
  1039. status:
  1040. type: integer
  1041. error:
  1042. type: string
  1043. data:
  1044. type: object
  1045. items:
  1046. type: object
  1047. properties:
  1048. country:
  1049. type: array
  1050. items:
  1051. type: object
  1052. properties:
  1053. name:
  1054. type: string
  1055. student_count:
  1056. type: integer
  1057. city:
  1058. type: array
  1059. items:
  1060. type: object
  1061. properties:
  1062. name:
  1063. type: string
  1064. no_of_male:
  1065. type: integer
  1066. no_of_female:
  1067. type: integer
  1068. examples:
  1069. application/json:
  1070. data:
  1071. country:
  1072. - name: Philippines
  1073. student_count: 20
  1074. city:
  1075. - name: Manila
  1076. no_of_male: 10
  1077. no_of_female: 4
  1078. - name: Quezon city
  1079. no_of_male: 3
  1080. no_of_female: 3
  1081. - name: United States
  1082. student_count: 25
  1083. city:
  1084. - name: New York
  1085. no_of_male: 8
  1086. no_of_female: 7
  1087. - name: San Jose
  1088. no_of_male: 4
  1089. no_of_female: 6
  1090. /students/students_gad:
  1091. get:
  1092. operationId: 'modules.students.students_age_gender_distribution'
  1093. summary: Get student gender age distribution list
  1094. tags:
  1095. - students
  1096. responses:
  1097. '200':
  1098. description: ''
  1099. schema:
  1100. type: object
  1101. properties:
  1102. data:
  1103. type: array
  1104. items:
  1105. type: object
  1106. properties:
  1107. age:
  1108. type: integer
  1109. no_of_males:
  1110. type: integer
  1111. no_of_females:
  1112. type: integer
  1113. examples:
  1114. application/json:
  1115. data:
  1116. - age: 24
  1117. no_of_male: 10
  1118. no_of_female: 11
  1119. - age: 25
  1120. no_of_male: 12
  1121. no_of_female: 10
  1122. /teachers:
  1123. get:
  1124. operationId: 'modules.teachers.get_teachers_list'
  1125. summary: Get a list of teachers
  1126. tags:
  1127. - teachers
  1128. responses:
  1129. '200':
  1130. description: ''
  1131. schema:
  1132. $ref: '#/definitions/teachers_all'
  1133. post:
  1134. operationId: 'modules.teachers.add_teacher'
  1135. summary: Add Teacher / Person
  1136. tags:
  1137. - teachers
  1138. parameters:
  1139. - name: body
  1140. in: body
  1141. schema:
  1142. $ref: '#/definitions/teacher_create'
  1143. responses:
  1144. '201':
  1145. description: ''
  1146. /teachers/{account_id}:
  1147. parameters:
  1148. - name: account_id
  1149. in: path
  1150. required: true
  1151. type: string
  1152. get:
  1153. operationId: 'modules.teachers.get_teacher'
  1154. summary: Get specific teacher
  1155. tags:
  1156. - teachers
  1157. responses:
  1158. '200':
  1159. description: ''
  1160. schema:
  1161. $ref: '#/definitions/teacher_details'
  1162. put:
  1163. operationId: 'modules.teachers.modify_teacher_info'
  1164. summary: Update specific teacher
  1165. tags:
  1166. - teachers
  1167. parameters:
  1168. - name: body
  1169. in: body
  1170. schema:
  1171. $ref: '#/definitions/teacher_modify'
  1172. responses:
  1173. '204':
  1174. description: ''
  1175. delete:
  1176. operationId: 'modules.teachers.delete_teacher'
  1177. summary: Delete Teachers
  1178. tags:
  1179. - teachers
  1180. responses:
  1181. '204':
  1182. description: ''
  1183. /paymentscheme:
  1184. post:
  1185. summary: Add payment schemes
  1186. tags:
  1187. - payment schemes
  1188. parameters:
  1189. - name: body
  1190. in: body
  1191. schema:
  1192. $ref: '#/definitions/add_payment_scheme'
  1193. responses:
  1194. '201':
  1195. description: ''
  1196. schema:
  1197. type: object
  1198. properties:
  1199. status:
  1200. type: integer
  1201. error:
  1202. type: string
  1203. /enrollments/course:
  1204. post:
  1205. operationId: 'modules.enrollments.enroll_subject'
  1206. summary: Create Enrollments
  1207. tags:
  1208. - enrollments
  1209. parameters:
  1210. - name: body
  1211. in: body
  1212. schema:
  1213. $ref: '#/definitions/enrollments_courses_input'
  1214. responses:
  1215. '201':
  1216. description: ''
  1217. schema:
  1218. $ref: '#/definitions/enrollments_courses_input'
  1219. /enrollments/programs:
  1220. post:
  1221. operationId: 'modules.enrollments.enroll_programs'
  1222. summary: Create Enrollments
  1223. tags:
  1224. - enrollments
  1225. parameters:
  1226. - name: body
  1227. in: body
  1228. schema:
  1229. $ref: '#/definitions/enrollments_programs_input'
  1230. responses:
  1231. '201':
  1232. description: ''
  1233. /enrollments/shortcourse:
  1234. post:
  1235. operationId: 'modules.enrollments.enroll_shortcourse'
  1236. summary: Create Enrollments
  1237. tags:
  1238. - enrollments
  1239. parameters:
  1240. - name: body
  1241. in: body
  1242. schema:
  1243. $ref: '#/definitions/enrollments_programs_input'
  1244. responses:
  1245. '201':
  1246. description: ''
  1247. /applications:
  1248. get:
  1249. operationId: 'modules.applications.get_applications_list'
  1250. summary: List all pending applications
  1251. tags:
  1252. - applications
  1253. responses:
  1254. '200':
  1255. description: ''
  1256. schema:
  1257. $ref: '#/definitions/applications_list'
  1258. definitions:
  1259. hello:
  1260. type: object
  1261. properties:
  1262. greeting:
  1263. type: string
  1264. accounts_full:
  1265. title: accounts Full
  1266. type: object
  1267. properties:
  1268. id:
  1269. type: integer
  1270. last_name:
  1271. type: string
  1272. first_name:
  1273. type: string
  1274. middle_name:
  1275. type: string
  1276. email:
  1277. type: string
  1278. password:
  1279. type: string
  1280. gender:
  1281. type: string
  1282. birth_year:
  1283. type: integer
  1284. birth_month:
  1285. type: integer
  1286. birth_day:
  1287. type: integer
  1288. school_id:
  1289. type: integer
  1290. school_name:
  1291. type: string
  1292. type:
  1293. type: integer
  1294. type_name:
  1295. type: string
  1296. outstanding_balance:
  1297. type: integer
  1298. date_created:
  1299. type: string
  1300. date_updated:
  1301. type: string
  1302. example:
  1303. id: 1
  1304. last_name: Ong
  1305. first_name: Miles
  1306. middle_name: Nolasco
  1307. email: miles.ong@seer_technologies.com
  1308. password: asdf1234
  1309. gender: Male
  1310. birth_year: 1993
  1311. birth_month: 5
  1312. birth_day: 10
  1313. school_id: 1
  1314. school_name: Ateneo de Manila University
  1315. type: 4
  1316. type_name: Student
  1317. outstanding_balance: -10000
  1318. date_created: 1/18/2016
  1319. date_updated: 7/18/2016
  1320. user_login:
  1321. type: object
  1322. properties:
  1323. email:
  1324. type: string
  1325. password:
  1326. type: string
  1327. example:
  1328. email: tricia.reyes@seer-technologies.com
  1329. password: test123
  1330. user_login_response:
  1331. type: object
  1332. properties:
  1333. account_id:
  1334. type: string
  1335. first_name:
  1336. type: string
  1337. last_name:
  1338. type: string
  1339. email:
  1340. type: string
  1341. position:
  1342. type: string
  1343. token:
  1344. type: string
  1345. example:
  1346. account_id: 1
  1347. email: tricia.reyes@seer-technologies.com
  1348. first_name: TRICIA
  1349. last_name: REYES
  1350. position: Student
  1351. token: 73a3e831e9e99b6e4ebfbcefff32e91
  1352. course_data:
  1353. title: course data
  1354. type: object
  1355. properties:
  1356. course_id:
  1357. type: integer
  1358. course_code:
  1359. type: string
  1360. title:
  1361. type: string
  1362. description:
  1363. type: string
  1364. units:
  1365. type: integer
  1366. product_name:
  1367. type: string
  1368. requirements:
  1369. type: array
  1370. items:
  1371. type: object
  1372. properties:
  1373. course_id:
  1374. type: integer
  1375. course_code:
  1376. type: string
  1377. requirement_type:
  1378. type: integer
  1379. published_price:
  1380. type: integer
  1381. product_type:
  1382. type: integer
  1383. programs_data:
  1384. title: programs data
  1385. type: object
  1386. properties:
  1387. product_name:
  1388. type: string
  1389. product_code:
  1390. type: string
  1391. description:
  1392. type: string
  1393. requirements:
  1394. type: array
  1395. items:
  1396. type: object
  1397. properties:
  1398. course_id:
  1399. type: integer
  1400. course_code:
  1401. type: string
  1402. requirement_type:
  1403. type: integer
  1404. programs_data_get:
  1405. type: array
  1406. items:
  1407. type: object
  1408. properties:
  1409. product_id:
  1410. type: integer
  1411. product_code:
  1412. type: string
  1413. title:
  1414. type: string
  1415. description:
  1416. type: string
  1417. units:
  1418. type: integer
  1419. requirements:
  1420. type: array
  1421. items:
  1422. type: object
  1423. properties:
  1424. course_id:
  1425. type: integer
  1426. course_code:
  1427. type: string
  1428. requirement_type:
  1429. type: integer
  1430. department_id:
  1431. type: integer
  1432. department_name:
  1433. type: string
  1434. published_price:
  1435. type: integer
  1436. product_type:
  1437. type: integer
  1438. example:
  1439. application/json:
  1440. - product_id: 0
  1441. product_code: string
  1442. title: string
  1443. description: string
  1444. units: 0
  1445. requirements:
  1446. - course_id: 0
  1447. course_code: string
  1448. requirement_type: 0
  1449. department_id: 0
  1450. department_name: string
  1451. published_price: 0
  1452. product_type: 0
  1453. students_full:
  1454. title: students Full
  1455. type: object
  1456. properties:
  1457. account_id:
  1458. type: integer
  1459. school_issued_id:
  1460. type: string
  1461. last_name:
  1462. type: string
  1463. first_name:
  1464. type: string
  1465. middle_name:
  1466. type: string
  1467. email:
  1468. type: string
  1469. password:
  1470. type: string
  1471. gender:
  1472. type: string
  1473. birth_day:
  1474. type: integer
  1475. birth_month:
  1476. type: integer
  1477. birth_year:
  1478. type: integer
  1479. address:
  1480. type: array
  1481. items:
  1482. properties:
  1483. id:
  1484. type: integer
  1485. address_line:
  1486. type: string
  1487. barangay:
  1488. type: string
  1489. city:
  1490. type: string
  1491. zip_code:
  1492. type: integer
  1493. state_province:
  1494. type: string
  1495. address_type:
  1496. type: string
  1497. country:
  1498. type: string
  1499. contacts:
  1500. type: array
  1501. items:
  1502. properties:
  1503. id:
  1504. type: integer
  1505. contact_info_type:
  1506. type: string
  1507. contact_detail:
  1508. type: integer
  1509. example:
  1510. account_id: 0
  1511. school_issued_id: string
  1512. last_name: string
  1513. first_name: string
  1514. middle_name: string
  1515. email: john.manauis@seer-technologies.com
  1516. password: pass123
  1517. gender: M
  1518. birth_day: 02
  1519. birth_month: 10
  1520. birth_year: 1982
  1521. address:
  1522. - address_line: Annex 45 Betterliving
  1523. barangay: Sun Valley
  1524. city: Paranaque
  1525. zip_code: 1711
  1526. state_province: Cagayan
  1527. address_type: Home Address
  1528. id: 0
  1529. country: Philippines
  1530. - address_line: Annex 45 Betterliving
  1531. barangay: Sun Valley
  1532. city: Paranaque
  1533. zip_code: 1711
  1534. state_province: Cagayan
  1535. address_type: Billing Address
  1536. id: 15
  1537. country: Philippines
  1538. contacts:
  1539. - id: 0
  1540. contact_info_type: Mobile Number
  1541. contact_detail: 639224181156
  1542. - contact_info_type: Secondary Mobile
  1543. contact_detail: 639224181157
  1544. id: 14
  1545. - contact_info_type: Fax Number
  1546. contact_detail: 123456
  1547. id: 15
  1548. teacher_course_assign:
  1549. title: Assign product to a teacher
  1550. type: object
  1551. properties:
  1552. product_id:
  1553. type: integer
  1554. example:
  1555. product_id: 12
  1556. students_gwa:
  1557. title: students genearal weighted average
  1558. type: object
  1559. properties:
  1560. status:
  1561. type: integer
  1562. data:
  1563. type: object
  1564. properties:
  1565. gwa:
  1566. type: integer
  1567. subjects:
  1568. type: array
  1569. items:
  1570. type: object
  1571. properties:
  1572. enrollment_id:
  1573. type: integer
  1574. course_code:
  1575. type: string
  1576. course_name:
  1577. type: string
  1578. course_units_lec:
  1579. type: integer
  1580. course_units_lab:
  1581. type: integer
  1582. course_grade:
  1583. type: integer
  1584. example:
  1585. gwa: 1.75
  1586. subjects:
  1587. - enrollment_id: 23
  1588. course_code: CS101
  1589. course_name: Computer Science 1
  1590. course_units_lec: 3
  1591. course_units_lab: 1
  1592. course_grade: 1.5
  1593. - enrollment_id: 26
  1594. course_code: CS102
  1595. course_name: Computer Science 2
  1596. course_units_lec: 3
  1597. course_units_lab: 1
  1598. course_grade: 2
  1599. teacher_products_matching:
  1600. title: students genearal weighted average
  1601. type: object
  1602. properties:
  1603. data:
  1604. type: object
  1605. properties:
  1606. email:
  1607. type: string
  1608. first_name:
  1609. type: string
  1610. last_name:
  1611. type: string
  1612. middle_name:
  1613. type: string
  1614. account_id:
  1615. type: integer
  1616. subjects:
  1617. type: array
  1618. items:
  1619. type: object
  1620. properties:
  1621. description:
  1622. type: string
  1623. lab_units:
  1624. type: integer
  1625. lecture_units:
  1626. type: integer
  1627. product_code:
  1628. type: string
  1629. product_name:
  1630. type: string
  1631. example:
  1632. email: kim.javier@seer-technologies.com
  1633. first_name: joseph
  1634. last_name: javier
  1635. middle_name: cruz
  1636. account_id: 1
  1637. subjects:
  1638. - description: Intro to computer science
  1639. lab_units: 4
  1640. lecture_units: 3
  1641. product_code: CS101
  1642. product_name: Introduction to computer science
  1643. - description: Intro to Discrete Math
  1644. lab_units: 4
  1645. lecture_units: 3
  1646. product_code: MAT032
  1647. product_name: Discrete Mathematics
  1648. show_applications:
  1649. title: show student program application
  1650. type: object
  1651. properties:
  1652. status:
  1653. type: integer
  1654. data:
  1655. type: object
  1656. properties:
  1657. gwa:
  1658. type: integer
  1659. programs:
  1660. type: array
  1661. items:
  1662. type: object
  1663. properties:
  1664. product_code:
  1665. type: string
  1666. product_name:
  1667. type: string
  1668. description:
  1669. type: string
  1670. rank:
  1671. type: integer
  1672. status:
  1673. type: integer
  1674. apply_applications:
  1675. title: Send Student Program Application
  1676. type: object
  1677. properties:
  1678. choices:
  1679. type: array
  1680. items:
  1681. type: object
  1682. properties:
  1683. product_id:
  1684. type: integer
  1685. rank:
  1686. type: integer
  1687. example:
  1688. choices:
  1689. - product_id: 3
  1690. rank: 1
  1691. - product_id: 2
  1692. rank: 2
  1693. - product_id: 1
  1694. rank: 3
  1695. teachers_all:
  1696. title: List of Mentors / Instructors / Teachers
  1697. type: array
  1698. items:
  1699. type: object
  1700. properties:
  1701. account_id:
  1702. type: integer
  1703. last_name:
  1704. type: string
  1705. first_name:
  1706. type: string
  1707. middle_name:
  1708. type: string
  1709. position:
  1710. type: integer
  1711. email:
  1712. type: string
  1713. example:
  1714. application/json:
  1715. - account_id: 0
  1716. last_name: Javier
  1717. first_name: Joseph Kim
  1718. middle_name: Panaligan
  1719. position: 5
  1720. email: kim.javier@seer-technologies.com
  1721. - account_id: 2
  1722. last_name: Manauis
  1723. first_name: John Patrick
  1724. middle_name: Reyes
  1725. position: 5
  1726. email: jp.mamauis@seer-technologies.com
  1727. teacher_details:
  1728. title: teacher all details
  1729. type: object
  1730. properties:
  1731. account_id:
  1732. type: integer
  1733. birth_year:
  1734. type: integer
  1735. birth_month:
  1736. type: integer
  1737. birth_day:
  1738. type: integer
  1739. last_name:
  1740. type: string
  1741. first_name:
  1742. type: string
  1743. middle_name:
  1744. type: string
  1745. email:
  1746. type: string
  1747. gender_type:
  1748. type: string
  1749. position:
  1750. type: integer
  1751. example:
  1752. last_name: Ong
  1753. first_name: Miles
  1754. middle_name: Nolasco
  1755. email: miles.ong@seer_technologies.com
  1756. gender_type: M
  1757. birth_year: 1993
  1758. birth_month: 5
  1759. birth_day: 10
  1760. account_id: 0
  1761. position: 5
  1762. teacher_create:
  1763. title: Body for create teacher
  1764. type: object
  1765. properties:
  1766. first_name:
  1767. type: string
  1768. last_name:
  1769. type: string
  1770. middle_name:
  1771. type: string
  1772. email:
  1773. type: string
  1774. password:
  1775. type: string
  1776. gender_type:
  1777. type: string
  1778. image_url:
  1779. type: string
  1780. birth_year:
  1781. type: integer
  1782. birth_month:
  1783. type: integer
  1784. birth_day:
  1785. type: integer
  1786. position:
  1787. type: integer
  1788. example:
  1789. first_name: Joseph
  1790. last_name: Javier
  1791. middle_name: Uy
  1792. email: joseph@test.com
  1793. password: test123
  1794. gender_type: M
  1795. image_url: http://www.jqueryscript.net/images/Simplest-Responsive-jQuery-Image-Lightbox-Plugin-simple-lightbox.jpg
  1796. birth_year: 2016
  1797. birth_month: 1
  1798. birth_day: 1
  1799. position: 10
  1800. teacher_modify:
  1801. title: teacher modify body
  1802. type: object
  1803. properties:
  1804. product_id:
  1805. type: integer
  1806. product_code:
  1807. type: string
  1808. title:
  1809. type: string
  1810. description:
  1811. type: string
  1812. units:
  1813. type: integer
  1814. requirements:
  1815. type: array
  1816. items:
  1817. type: object
  1818. properties:
  1819. course_id:
  1820. type: integer
  1821. course_code:
  1822. type: string
  1823. requirement_type:
  1824. type: integer
  1825. department_id:
  1826. type: integer
  1827. department_name:
  1828. type: string
  1829. published_price:
  1830. type: integer
  1831. product_type:
  1832. type: integer
  1833. example:
  1834. application/json:
  1835. - product_id: 0
  1836. product_code: string
  1837. title: string
  1838. description: string
  1839. units: 0
  1840. requirements:
  1841. - course_id: 0
  1842. course_code: string
  1843. requirement_type: 0
  1844. department_id: 0
  1845. department_name: string
  1846. published_price: 0
  1847. product_type: 0
  1848. add_payment_scheme:
  1849. type: object
  1850. properties:
  1851. name:
  1852. type: string
  1853. items:
  1854. type: array
  1855. items:
  1856. type: object
  1857. properties:
  1858. installment_number:
  1859. type: integer
  1860. percentage:
  1861. type: integer
  1862. example:
  1863. name: 2-part installment scheme
  1864. items:
  1865. - installment_number: 1
  1866. percentage: 30
  1867. - installment_number: 2
  1868. percentage: 70
  1869. enrollments_programs_input:
  1870. title: program enrollments input
  1871. type: object
  1872. properties:
  1873. account_id:
  1874. type: integer
  1875. product_offering_id:
  1876. type: integer
  1877. example:
  1878. account_id: 1
  1879. product_offering_id: 1
  1880. enrollments_courses_input:
  1881. type: object
  1882. properties:
  1883. account_id:
  1884. type: integer
  1885. courses_to_enroll:
  1886. type: array
  1887. items:
  1888. type: object
  1889. properties:
  1890. course_id:
  1891. type: integer
  1892. status:
  1893. type: integer
  1894. example:
  1895. account_id: 5
  1896. courses_to_enroll:
  1897. - course_id: 21
  1898. - course_id: 22
  1899. applications_list:
  1900. title: Applications List Body
  1901. type: object
  1902. properties:
  1903. account_id:
  1904. type: integer
  1905. first_name:
  1906. type: string
  1907. middle_name:
  1908. type: string
  1909. last_name:
  1910. type: string
  1911. email:
  1912. type: string
  1913. gender_type:
  1914. type: string
  1915. birth_day:
  1916. type: integer
  1917. birth_month:
  1918. type: integer
  1919. birth_year:
  1920. type: integer
  1921. student_number:
  1922. type: string
  1923. year_entered:
  1924. type: integer
  1925. student_type:
  1926. type: string
  1927. student_requirements:
  1928. type: array
  1929. items:
  1930. type: object
  1931. properties:
  1932. requirements:
  1933. type: string
  1934. status:
  1935. type: string
  1936. student_applications:
  1937. type: array
  1938. items:
  1939. type: object
  1940. properties:
  1941. product_code:
  1942. type: string
  1943. product_name:
  1944. type: string
  1945. description:
  1946. type: string
  1947. published_price:
  1948. type: string
  1949. product_type:
  1950. type: string
  1951. rank:
  1952. type: integer
  1953. example:
  1954. account_id: 7
  1955. first_name: JOSELITO MIGUEL
  1956. middle_name:
  1957. last_name: HERNANDEZ
  1958. email: miguel.hernandez@seer-technologies.com
  1959. gender_type: M
  1960. birth_day: 01
  1961. birth_month: 01
  1962. birth_year: 1990
  1963. year_entered: 2017
  1964. student_type: Freshman
  1965. student_requirements:
  1966. - requirements: Highschool Diploma
  1967. status: 1
  1968. - requirements: Highschool TOR
  1969. status: 1
  1970. - requirements: Highschool Report Card
  1971. status: 1
  1972. student_applications:
  1973. - product_code: BS CS
  1974. prodcut_name: Bachelor of Science in Computer Science
  1975. description:
  1976. published_price: 0
  1977. product_type:
  1978. rank: 1
  1979. - product_code: BS IT
  1980. product_name: Bachelor of Science in Information Technology
  1981. description:
  1982. published_price: 0
  1983. product_type:
  1984. rank: 2
  1985. - product_code: BS COMENG
  1986. product_name: Bachelor of Science in Computer Engineering
  1987. description:
  1988. published_price: 0
  1989. product_type:
  1990. rank: 3
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!