Skip to content

Latest commit

 

History

History
154 lines (135 loc) · 3.68 KB

REST_API.md

File metadata and controls

154 lines (135 loc) · 3.68 KB

Deloitte-Middleware-API

The Middleware Application is used to fetch the data from SABA DEP of Deloitte and store it in the local data.

There are a total of 3 REST API endpoints

  • Courses
  • Learners
  • Course Histories

REST APIs :

Courses

  • endpoint:
    /api/Course
  • method: POST
  • parameters:
Name In Type Required Description
COURSE_ID
Body String True Course ID is used to create a course in the database. This is an external course id not generated by the application!
COURSE_TITLE
Body String True Course TITLE is the name of the course present in the DEP.
access-token
Headers String True RSA encrypted API key for authentication. The access-token shall be provided to you. Don't share the access-token without supervision.
  • endpoint:
    /api/Course
  • method: GET
  • parameters:
Name In Type Required Description
access-token
Headers String True RSA encrypted API key for authentication. The access-token shall be provided to you. Don't share the access-token without supervision.

Leaners

  • endpoint:
    /api/Learner
  • method: POST
  • parameters:
Name In Type Required Description
LEARNER_ID
Body String True LEARNER ID is used to create a learner in the database. This is an external learner id not generated by the application! The LEARNER_ID should be same as the LEARNER_ID in DEP.
LEARNER_EMAIL
Body String True LEARNER_EMAIL is the email of learners present in the DEP.
access-token
Headers String True RSA encrypted API key for authentication. The access-token shall be provided to you. Don't share the access-token without supervision.
  • endpoint:
    /api/Learner
  • method: GET
  • parameters:
Name In Type Required Description
access-token
Headers String True RSA encrypted API key for authentication. The access-token shall be provided to you. Don't share the access-token without supervision.

Course History

  • endpoint:
    /api/CourseHistory
  • method: GET
  • parameters:
Name In Type Required Description
access-token
Headers String True RSA encrypted API key for authentication. The access-token shall be provided to you. Don't share the access-token without supervision.