University Web Portal - Technical Document

Introduction

  • Samarth Uni Web Portal is an API (Application Programming Interface) platform for Samarth Portal. Universities using the Samarth portal can use these API to fetch details of their Programmes, Organisations, and Employees.

Note

A unique Access Token is required for Authentication which will be provided by Samarth Team.

Programme API

METHOD - GET

[USE CASE]{.ul}
To get all the Programme

REQUEST ATTRIBUTES
API Content format : JSON
[All Programme]{.ul}
API Endpoint -
https://<CU Samarth Link>/index.php/v1/programme/get\

Response

AttributeTypeDescriptionMandatory
programme_idNumberProgramme IdNo
programme_nameStringProgram name Full TextNo
programme_codeStringProgram CodeNo
descriptionStringSummary of the courseNo
structureStringStructure of the courseNo
eligibilityStringEligibility to Opt for courseNo
durationStringDuration of the CourseNo
fee_structureStringFee structureNo
programme_detailsStringProgramme DetailsNo

[by ID]{.ul}
API Endpoint -
https://<CU Samarth Link>/index.php/v1/programme/id\

REQUEST

ParameterTypeDescriptionMandatory
idNumberId of ProgrammeYes

Response

AttributeTypeDescriptionMandatory
programme_idNumberProgramme IdNo
programme_nameStringProgram name Full TextNo
programme_codeStringProgram CodeNo
descriptionStringSummary of the courseNo
structureStringStructure of the courseNo
eligibilityStringEligibility to Opt for courseNo
durationStringDuration of the CourseNo
fee_structureStringFee structureNo
programme_detailsStringProgramme DetailsNo
programme_coordinatorStringProgramme CoordinatorNo

[by Level]{.ul}
API Endpoint -
https://<CU Samarth Link>/index.php/v1/programme/level
REQUEST

ParameterTypeDescriptionMandatory
levelStringLevel Name (BACHELOR, Masters)Yes

Response

AttributeTypeDescriptionMandatory
programme_idNumberProgramme IdNo
programme_nameStringProgram name Full TextNo
programme_codeStringProgram CodeNo
descriptionStringSummary of the courseNo
structureStringStructure of the courseNo
eligibilityStringEligibility to Opt for courseNo
durationStringDuration of the CourseNo
fee_structureStringFee structureNo
programme_detailsStringProgramme DetailsNo
programme_coordinatorStringProgramme CoordinatorNo

Organizational Unit**

METHOD - GET

[USE CASE]{.ul}
To get all the Organizational Unit

REQUEST ATTRIBUTES
API Content format : JSON

API Endpoint -
https://<CU Samarth Link>/index.php/v1/organizational-unit/get


ParameterTypeDescriptionMandatory
typeStringType of Organizational Unit ex. Campus departmentNo
idNumberId of Organizational UnitNo

[by Type]{.ul}\

Response

AttributeTypeDescriptionMandatory
typeStringType Of Organizational UnitNo
nameStringName of Organizational UnitNo
name_in_hindiStringName of Organizational Unit in HindiNo
name_in_other_languageStringName of Organizational Unit in another languageNo
codeStringCode of Organizational UnitNo
profileStringName of Organizational UnitNo
official_emailStringEmail of Organizational UnitNo
address_line_1StringAddress Line 1 of Organizational UnitNo
address_line_2StringAddress Line 2 of Organizational UnitNo
address_line_3StringAddress Line 3 of Organizational UnitNo
districtStringDistrict of Organizational UnitNo
cityStringCity of Organizational UnitNo
stateStringState of Organizational UnitNo
countryStringCountry of Organizational UnitNo
pincodeNumberPincode of Organizational UnitNo
telephone_numberNumber Tel of Organizational UnitNo
websiteStringWebsite of Organizational UnitNo
facebook_linkStringFacebook Link of Organizational UnitNo
linkedin_linkStringLinkedinNo
twitter_linkStringTwitterNo
logoStringlogoNo

[by ID]{.ul}\

Response

AttributeTypeDescriptionMandatory
typeStringType Of Organizational UnitNo
nameStringName of Organizational UnitNo
name_in_hindiStringName of Organizational Unit in HindiNo
name_in_other_languageStringName of Organizational Unit in another languageNo
codeStringCode of Organizational UnitNo
profileString Name of Organizational UnitNo
official_emailStringEmail of Organizational UnitNo
address_line_1StringAddress Line 1 of Organizational UnitNo
address_line_2StringAddress Line 2 of Organizational UnitNo
address_line_3StringAddress Line 3 of Organizational UnitNo
districtStringDistrict of Organizational UnitNo
cityStringCity of Organizational UnitNo
stateStringState of Organizational UnitNo
countryStringCountry of Organizational UnitNo
pincodeNumberPincode of Organizational UnitNo
telephone_numberNumberTel of Organizational UnitNo
websiteStringWebsite of Organizational UnitNo
facebook_linkStringFacebook Link of Organizational UnitNo
linkedin_linkStringLinkedin No
twitter_linkStringTwitter No
logoStringlogoNo

[All Organizational Unit]{.ul}\

Response

AttributeTypeDescriptionMandatory
typeStringType Of Organizational UnitNo
nameStringName of Organizational UnitNo
name_in_hindiStringName of Organizational Unit in HindiNo
name_in_other_languageStringName of Organizational Unit in another languageNo
codeStringCode of Organizational UnitNo
profileStringName of Organizational UnitNo
official_emailStringEmail of Organizational UnitNo
address_line_1StringAddress Line 1 of Organizational UnitNo
address_line_2StringAddress Line 2 of Organizational UnitNo
address_line_3StringAddress Line 3 of Organizational UnitNo
districtStringDistrict of Organizational UnitNo
cityStringCity of Organizational UnitNo
stateStringState of Organizational UnitNo
countryStringCountry of Organizational UnitNo
pincodeNumberPincode of Organizational UnitNo
telephone_numberNumberTel of Organizational UnitNo
websiteStringWebsite of Organizational UnitNo
facebook_linkStringFacebook Link of Organizational UnitNo
linkedin_linkStringLinkedinNo
twitter_linkStringTwitterNo
logoStringlogoNo

Employee

METHOD - GET

[USE CASE]{.ul}
To get all the employee

REQUEST ATTRIBUTES
API Content format : JSON

API Endpoint -
https://<CU Samarth Link>/index.php/v1/employee/get

ParameterTypeDescriptionMandatory
ouNumberId of Organizational UnitNO
designationNumberDesignation IdNo

[By Organizational Unit]{.ul}\

REQUEST

ParameterTypeDescriptionMandatory
ouNumberId of ouYes

Response

AttributeTypeDescriptionMandatory
titleStringTitle of EmployeeNo
first_nameStringFirst Name of EmployeeNo
middle_nameStringMiddle Name of EmployeeNo
last_nameStringLast Name of EmployeeNo
guardian_nameStringEmployee Guardian NameNo
mother_nameStringEmployee Mother NameNo
marital_statusStringMarital Status of EmployeeNo
blood_groupStringBlood Group of employeeNo
nationalityStringNationality of EmployeeNo
date_of_birthStringDOB of employeeNo
mobile_numberStringMobile of employeeNo
personal_emailStringPersonal Email of employeeNo
employee_typeStringEmployee TypeNo
nature_of_employmentNumberNature of EmploymentNo
organization_unitNumberEmployee Organizational UnitNo
designationStringDesignation of employeeNo
employee_codeStringEmployee CodeNo
ledger_numberStringEmployee LedgerNo
date_of_joiningStringDate of JoiningNo
qualificationStringQualificationNo
official_emailStringOfficial EmailNo
aadhar_numberStringAadhar NumberNo
official_websiteStringOfficial WebsiteNo
personal_websiteStringPersonal WebsiteNo
pan_numberStringPan NumberNo
residential_addressNumberResidential AddressNo
residential_pincodeNumberResidential PincodeNo
residential_countryStringResidential CountryNo
residential_stateStringResidential StateNo
residential_cityStringResidential CityNo
residential_phone_numberStringResidentia Phone NumberNo
permanent_addressStringPermanent AddressNo
permanent_pincodeStringPermanent PincodeNo
permanent_countryStringPermanent CountryNo
permanent_stateStringPermanent StateNo
permanent_cityStringPermanent CityNo
bank_account_numberStringBank Account NumberNo
bank_nameNumberBank NameNo
branch_nameNumberBranch NameNo
ifsc_codeStringIfsc CodeNo
photo_uploadStringPhoto urlNo

[By Designation]{.ul}\

REQUEST

ParameterTypeDescriptionMandatory
designationNumberId of DesignationNo

Response

AttributeTypeDescriptionMandatory
titleStringTitle of EmployeeNo
first_nameStringFirst Name of EmployeeNo
middle_nameStringMiddle Name of EmployeeNo
last_nameStringLast Name of EmployeeNo
guardian_nameStringEmployee Guardian NameNo
mother_nameStringEmployee Mother NameNo
marital_statusStringMarital Status of EmployeeNo
blood_groupStringBlood Group of employeeNo
nationalityStringNationality of EmployeeNo
date_of_birthStringDOB of employeeNo
mobile_numberStringMobile of employeeNo
personal_emailStringPersonal Email of employeeNo
employee_typeStringEmployee TypeNo
nature_of_employmentNumberNature of EmploymentNo
organization_unitNumberEmployee Organizational UnitNo
designationStringDesignation of employeeNo
employee_codeStringEmployee CodeNo
ledger_numberStringEmployee LedgerNo
date_of_joiningStringDate of JoiningNo
qualificationStringQualificationNo
official_emailStringOfficial EmailNo
aadhar_numberStringAadhar NumberNo
official_websiteStringOfficial WebsiteNo
personal_websiteStringPersonal WebsiteNo
pan_numberStringPan NumberNo
residential_addressNumberResidential AddressNo
residential_pincodeNumberResidential PincodeNo
residential_countryStringResidential CountryNo
residential_stateStringResidential StateNo
residential_cityStringResidential CityNo
residential_phone_numberStringResidential Phone NumberNo
permanent_addressStringPermanent AddressNo
permanent_pincodeStringPermanent PincodeNo
permanent_countryStringPermanent CountryNo
permanent_stateStringPermanent StateNo
permanent_cityStringPermanent CityNo
bank_account_numberStringBank Account NumberNo
bank_nameNumberBank NameNo
branch_nameNumberBranch NameNo
ifsc_codeStringIfsc CodeNo
photo_uploadStringPhoto urlNo

[All Employee]{.ul}\

Response

AttributeTypeDescriptionMandatory
titleStringTitle of EmployeeNo
first_nameStringFirst Name of EmployeeNo
middle_nameStringMiddle Name of EmployeeNo
last_nameStringLast Name of EmployeeNo
guardian_nameStringEmployee Guardian NameNo
mother_nameStringEmployee Mother NameNo
marital_statusStringMarital Status of EmployeeNo
blood_groupStringBlood Group of employeeNo
nationalityStringNationality of EmployeeNo
date_of_birthStringDOB of employeeNo
mobile_numberStringMobile of employeeNo
personal_emailStringPersonal Email of employeeNo
employee_typeStringEmployee TypeNo
nature_of_employmentNumberNature of EmploymentNo
organization_unitNumberEmployee Organizational UnitNo
designationStringDesignation of employeeNo
employee_codeStringEmployee CodeNo
ledger_numberStringEmployee LedgerNo
date_of_joiningStringDate of JoiningNo
qualificationStringQualificationNo
official_emailStringOfficial EmailNo
aadhar_numberStringAadhar NumberNo
official_websiteStringOfficial WebsiteNo
personal_websiteStringPersonal WebsiteNo
pan_numberStringPan NumberNo
residential_addressNumberResidential AddressNo
residential_pincodeNumberResidential PincodeNo
residential_countryStringResidential CountryNo
residential_stateStringResidential StateNo
residential_cityStringResidential CityNo
residential_phone_numberStringResidential Phone NumberNo
permanent_addressStringPermanent AddressNo
permanent_pincodeStringPermanent PincodeNo
permanent_countryStringPermanent CountryNo
permanent_stateStringPermanentState
permanent_cityStringPermanent CityNo
bank_account_numberStringBank Account NumberNo
bank_nameNumberBank NameNo
branch_nameNumberBranch NameNo
ifsc_codeStringIfsc CodeNo
photo_uploadStringPhoto urlNo

[By Id]{.ul}\

REQUEST

ParameterTypeDescriptionMandatory
idNumberEmployee IDNo

Response

AttributeTypeDescriptionMandatory
titleStringTitle of EmployeeNo
first_nameStringFirst Name of EmployeeNo
middle_nameStringMiddle Name of EmployeeNo
last_nameStringLast Name of EmployeeNo
guardian_nameStringEmployee Guardian NameNo
mother_nameStringEmployee Mother NameNo
marital_statusStringMarital Status of EmployeeNo
blood_groupStringBlood Group of employeeNo
date_of_birthStringDOB of employeeNo
mobile_numberStringMobile of employeeNo
personal_emailStringPersonal Email of employeeNo
employee_typeStringEmployee TypeNo
nature_of_employmentNumberNature of EmploymentNo
organization_unitNumberEmployee Organizational UnitNo
designationStringDesignation of employeeNo
employee_codeStringEmployee CodeNo
ledger_numberStringEmployee LedgerNo
date_of_joiningStringDate of JoiningNo
qualificationStringQualificationNo
official_emailStringOfficial EmailNo
aadhar_numberStringAadhar NumberNo
official_websiteStringOfficial WebsiteNo
personal_websiteStringPersonal WebsiteNo
pan_numberStringPan NumberNo
residential_addressNumberResidential AddressNo
residential_pincodeNumberResidential PincodeNo
residential_countryStringResidential CountryNo
residential_stateStringResidential StateNo
residential_cityStringResidential CityNo
residential_phone_numberStringResidential Phone NumberNo
permanent_addressStringPermanent AddressNo
permanent_pincodeStringPermanent PincodeNo
permanent_countryStringPermanent CountryNo
permanent_stateStringPermanent StateNo
permanent_cityStringPermanent CityNo
bank_account_numberStringBank Account NumberNo
bank_nameNumberBank NameNo
branch_nameNumberBranch NameNo
ifsc_codeStringIfsc CodeNo
photo_uploadStringPhoto urlNo

Diagrams

Uni Web Portal Activity Diagram

...

Uni Web Portal Use Case Diagram

...

External Resources

📹 Module Training Video ⤤

Edit this page