SubmitExamLetter
| API | Description |
|---|---|
| POST api/{version}/SubmitExamLetter/GetSubmitExamDateDetails |
No documentation available. |
| POST api/{version}/SubmitExamLetter/SaveExamDateDetails?currentRegId={currentRegId} |
No documentation available. |
| GET api/{version}/SubmitExamLetter/GetExamDateSubmissionRequired?studentId={studentId}®istrationId={registrationId} |
Used to get the exam date submittion required details |
| POST api/SubmitExamLetter/GetSubmitExamDateDetails |
No documentation available. |
| POST api/SubmitExamLetter/SaveExamDateDetails?currentRegId={currentRegId} |
No documentation available. |
| GET api/SubmitExamLetter/GetExamDateSubmissionRequired?studentId={studentId}®istrationId={registrationId} |
Used to get the exam date submittion required details |
CorporateRemainder
Cartrover controller
| API | Description |
|---|---|
| POST api/{version}/CorporateRemainder/SendCorporateCodeRemainderMail |
API call to add all shippable product as new order to cartrover api |
| POST api/CorporateRemainder/SendCorporateCodeRemainderMail |
API call to add all shippable product as new order to cartrover api |
FlashCard
StudyHubAPI
CalendarSync
| API | Description |
|---|---|
| POST api/{version}/CalendarSync/ProcessCalendarEventQueue |
No documentation available. |
| POST api/{version}/CalendarSync/SyncCalendarEventQueue?currentDate={currentDate} |
No documentation available. |
| POST api/CalendarSync/ProcessCalendarEventQueue |
No documentation available. |
| POST api/CalendarSync/SyncCalendarEventQueue?currentDate={currentDate} |
No documentation available. |
Discount
StudyHub2
Ebook
Student Module - EBook related API's
PaymentDueReminder
Payment due reminder controller
| API | Description |
|---|---|
| POST api/{version}/PaymentDueReminder/SendPaymentDueReminder |
API call to Send the payment due Reminder |
| POST api/{version}/PaymentDueReminder/SendMailPaymentDueReport |
No documentation available. |
| POST api/PaymentDueReminder/SendPaymentDueReminder |
API call to Send the payment due Reminder |
| POST api/PaymentDueReminder/SendMailPaymentDueReport |
No documentation available. |
StudentCourseStudyPlan
This controller has all the methods for student course study plan
StudentProductShipment
StudentProductShipment controller
StudentCourseMaterial
This controller have all the action of Personalized learning module.
Students
This api controller contains all the methods related to student and student registrations.
WeeklyQuestion
Controller holds all the available methods related to Test Link.
| API | Description |
|---|---|
| GET api/{version}/WeeklyQuestion/GetWeeklyQuestionUrl?studentPushNotificationId={studentPushNotificationId}&studentId={studentId} |
Used to get the Test Link and Status of the test |
| GET api/WeeklyQuestion/GetWeeklyQuestionUrl?studentPushNotificationId={studentPushNotificationId}&studentId={studentId} |
Used to get the Test Link and Status of the test |
MyAccount
Student Module - My profile details related API's Created by vijay | 2020-08-18
Tapfiliate
| API | Description |
|---|---|
| POST api/{version}/Tapfiliate/UpdateConversionDetails |
To integrate tapfiliate conversion api into IMS |
| POST api/{version}/Tapfiliate/GetAllConversionAPIIntegration?FilterStartDate={FilterStartDate}&FilterMonth={FilterMonth} |
To Get tapfiliate conversion api With Date Filter |
| POST api/Tapfiliate/UpdateConversionDetails |
To integrate tapfiliate conversion api into IMS |
| POST api/Tapfiliate/GetAllConversionAPIIntegration?FilterStartDate={FilterStartDate}&FilterMonth={FilterMonth} |
To Get tapfiliate conversion api With Date Filter |
SubmitExamResult
| API | Description |
|---|---|
| POST api/{version}/SubmitExamResult/SendSubmitExamResultNotifications?noOfRecords={noOfRecords}&maxNoOfPastDates={maxNoOfPastDates} |
To send exam result link to students |
| POST api/SubmitExamResult/SendSubmitExamResultNotifications?noOfRecords={noOfRecords}&maxNoOfPastDates={maxNoOfPastDates} |
To send exam result link to students |
StudentAttendance
| API | Description |
|---|---|
| GET api/{version}/StudentAttendance/FillStudentTable?registrationid={registrationid}&pageNumber={pageNumber} |
Getting Student Attendance Report |
| GET api/{version}/StudentAttendance/GenerateAttendancePdf?registrationid={registrationid}&divisionId={divisionId} |
Used to generate attendance details as pdf |
| GET api/StudentAttendance/FillStudentTable?registrationid={registrationid}&pageNumber={pageNumber} |
Getting Student Attendance Report |
| GET api/StudentAttendance/GenerateAttendancePdf?registrationid={registrationid}&divisionId={divisionId} |
Used to generate attendance details as pdf |
PaymentConfirmation
PrintedBookProduct
Printed book controller
| API | Description |
|---|---|
| GET api/{version}/PrintedBookProduct/GetPrintedBookDetails?StudentProductId={StudentProductId} |
To Get the Printed Book Product Details |
| GET api/{version}/PrintedBookProduct/GetBookTrackForMobile?StudentProductId={StudentProductId}&StudentProductShipmentId={StudentProductShipmentId} |
To Get the Printed Book Product Details |
| GET api/PrintedBookProduct/GetPrintedBookDetails?StudentProductId={StudentProductId} |
To Get the Printed Book Product Details |
| GET api/PrintedBookProduct/GetBookTrackForMobile?StudentProductId={StudentProductId}&StudentProductShipmentId={StudentProductShipmentId} |
To Get the Printed Book Product Details |
ContactManager
FeedbackEvaluation
Controller holds all the available methods related to Evaluation.
Avalara
Tutoring
Regarding tutoring related calls from studyhub
User
RepeatRegistration
PracticePortalProduct
Cartrover controller
PurchaseAddons
Controller holds all the available methods related to purchase addons.
OrderInvoice
| API | Description |
|---|---|
| GET api/{version}/OrderInvoice/GetStudentOrderInvoice?studentId={studentId}&orderId={orderId}&DivisionId={DivisionId} |
Used to load student invoice details by order. |
| GET api/OrderInvoice/GetStudentOrderInvoice?studentId={studentId}&orderId={orderId}&DivisionId={DivisionId} |
Used to load student invoice details by order. |
TestV1
This is Test controler for version check
| API | Description |
|---|---|
| GET api/{version}/TestV1/m1 |
Test method |
| GET api/TestV1/m1 |
Test method |
StudentNotification
Controller holds all the available methods related to Evaluation.
General
This is the testing controller used for all the general testing purpose.
| API | Description |
|---|---|
| POST api/{version}/General/UpdateVzaar |
No documentation available. |
| POST api/{version}/General/UpdateBlobUsingTask |
No documentation available. |
| POST api/{version}/General/UpdateBlob |
No documentation available. |
| POST api/{version}/General/InsertEmailQ?data={data} |
No documentation available. |
| GET api/{version}/General/m1 |
This is the test method, Used for just showing purpose |
| POST api/{version}/General/m2 |
This is the test method, Used to access from IMS |
| GET api/{version}/General/getKey |
This method used to generate a JWT Key |
| POST api/{version}/General/expception |
This is the test method for create a exception |
| POST api/{version}/General/DatatableToJobject |
DataTable to List(JObject) Sample |
| POST api/{version}/General/DatatableToList |
DataTable to List(Dictionary(string, object)) Sample |
| POST api/General/UpdateVzaar |
No documentation available. |
| POST api/General/UpdateBlobUsingTask |
No documentation available. |
| POST api/General/UpdateBlob |
No documentation available. |
| POST api/General/InsertEmailQ?data={data} |
No documentation available. |
| GET api/General/m1 |
This is the test method, Used for just showing purpose |
| POST api/General/m2 |
This is the test method, Used to access from IMS |
| GET api/General/getKey |
This method used to generate a JWT Key |
| POST api/General/expception |
This is the test method for create a exception |
| POST api/General/DatatableToJobject |
DataTable to List(JObject) Sample |
| POST api/General/DatatableToList |
DataTable to List(Dictionary(string, object)) Sample |
TestV2
This is Test controler for version check
| API | Description |
|---|---|
| GET api/{version}/TestV2/m1 |
Test method |
| GET api/TestV2/m1 |
Test method |
Registration
Registration controller All the registration wise all request available here
OrderApi
| API | Description |
|---|---|
| GET api/{version}/OrderApi/GetProductDetails?productId={productId} |
Sample code to get product detail using Web Api |
| POST api/{version}/OrderApi/SaveStudentOrder |
Used for saving entire student product purchase detail |
| POST api/{version}/OrderApi/GetTaxForApplicableProducts |
Used for calculating the tax for each product |
| GET api/OrderApi/GetProductDetails?productId={productId} |
Sample code to get product detail using Web Api |
| POST api/OrderApi/SaveStudentOrder |
Used for saving entire student product purchase detail |
| POST api/OrderApi/GetTaxForApplicableProducts |
Used for calculating the tax for each product |
VideoHub
SSOSendMail
| API | Description |
|---|---|
| POST api/{version}/SSOSendMail/SendMailToEnableSSO |
No documentation available. |
| POST api/{version}/SSOSendMail/getSSOLoginIdentity?firstName={firstName}&lastName={lastName}&emailAddress={emailAddress} |
Get user details for SSO |
| POST api/{version}/SSOSendMail/loginpurchase?emailaddress={emailaddress} |
No documentation available. |
| POST api/SSOSendMail/SendMailToEnableSSO |
No documentation available. |
| POST api/SSOSendMail/getSSOLoginIdentity?firstName={firstName}&lastName={lastName}&emailAddress={emailAddress} |
Get user details for SSO |
| POST api/SSOSendMail/loginpurchase?emailaddress={emailaddress} |
No documentation available. |
Support
For IMS application support purpose
| API | Description |
|---|---|
| POST api/{version}/Support/SendStudentSupportMail |
Send support email to student |
| POST api/Support/SendStudentSupportMail |
Send support email to student |
InstructorInvoice
| API | Description |
|---|---|
| GET api/{version}/InstructorInvoice/GetInvoicedAmount?invoiceNumber={invoiceNumber} |
No documentation available. |
| POST api/{version}/InstructorInvoice/CalculateInvoicedAmount |
No documentation available. |
| POST api/{version}/InstructorInvoice/UpdatedInstructorInvoicedAmount |
No documentation available. |
| GET api/InstructorInvoice/GetInvoicedAmount?invoiceNumber={invoiceNumber} |
No documentation available. |
| POST api/InstructorInvoice/CalculateInvoicedAmount |
No documentation available. |
| POST api/InstructorInvoice/UpdatedInstructorInvoicedAmount |
No documentation available. |
PromotionalDiscount
StudentDiscussion
Its contains all the Discussion forum and Question to instructor related action
CartRover
Cartrover controller
| API | Description |
|---|---|
| POST api/{version}/CartRover/AddNewOrderToCartRover |
API call to add all shippable product as new order to cartrover api |
| POST api/{version}/CartRover/UpdateEachOrderFromCartRover |
API call to update all order status from cartrover to ims |
| POST api/{version}/CartRover/AddProductsToThreePL |
Move the studentproduct to 3PL from Ups Shipping for Products Screen |
| POST api/{version}/CartRover/CheckAndInsertCartRoverCarrierMethods |
Used to check whether the 3PL Carrier is already imported. If not import it |
| POST api/CartRover/AddNewOrderToCartRover |
API call to add all shippable product as new order to cartrover api |
| POST api/CartRover/UpdateEachOrderFromCartRover |
API call to update all order status from cartrover to ims |
| POST api/CartRover/AddProductsToThreePL |
Move the studentproduct to 3PL from Ups Shipping for Products Screen |
| POST api/CartRover/CheckAndInsertCartRoverCarrierMethods |
Used to check whether the 3PL Carrier is already imported. If not import it |
PaymentHub
WeeklyQuestions
| API | Description |
|---|---|
| POST api/{version}/WeeklyQuestions/SendWeeklyQuestionNotifications |
To send mobile and web notification for weekly questions |
| POST api/WeeklyQuestions/SendWeeklyQuestionNotifications |
To send mobile and web notification for weekly questions |
ProductWebsite
Test
This is Test controler for version check
| API | Description |
|---|---|
| GET api/{version}/Test/m1 |
Test method |
| GET api/Test/m1 |
Test method |
ProductSubscription
This controller for product subscription related request Created by Vijayendran R | 2020-11-28
Corporate
UpgradePlan
AvalaraTax
Avalara Tax controller
| API | Description |
|---|---|
| POST api/{version}/AvalaraTax/AddNewProductToAvalara?FilterDate={FilterDate} |
API call to push the Tax amount and Details |
| POST api/AvalaraTax/AddNewProductToAvalara?FilterDate={FilterDate} |
API call to push the Tax amount and Details |