Page tree
Skip to end of metadata
Go to start of metadata


1.Introduction

  • Samarth Uni Web Portal is an API (Application Programming Interface) platform for Samarth Portal. Universities using 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.



2. Programme API


METHOD - GET


USE CASE
To get all the Programme



REQUEST ATTRIBUTES
API Content format : JSON
All Programme
API Endpoint -
https://<CU Samarth Link>/index.php/v1/programme/get
Response

Attribute

Type

Description

Mandatory

programme_id

Number

Programme Id

No

programme_name

String

Program name Full Text

No

programme_code

String

Program Code

No

description

String

Summary of the course

No

structure

String

Structure of the course

No

eligibility

String

Eligibility to Opt for course

No

duration

String

Duration of the Course

No

fee_structure

String

Fee structure

No

programme_details

String

Programme Details

No



by ID
API Endpoint -
https://<CU Samarth Link>/index.php/v1/programme/id
REQUEST

Parameter

Type

Description

Mandatory

id

Number

Id of Programme

Yes



Response

Attribute

Type

Description

Mandatory

programme_id

Number

Programme Id

No

programme_name

String

Program name Full Text

No

programme_code

String

Program Code

No

description

String

Summary of the course

No

structure

String

Structure of the course

No

eligibility

String

Eligibility to Opt for course

No

duration

String

Duration of the Course

No

fee_structure

String

Fee structure

No

programme_details

String

Programme Details

No

programme_coordinator

String

Programme Coordinator

No






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

Parameter

Type

Description

Mandatory

level

String

Level Name (BACHELOR,Masters)

Yes



Response

Attribute

Type

Description

Mandatory

programme_id

Number

Programme Id

No

programme_name

String

Program name Full Text

No

programme_code

String

Program Code

No

description

String

Summary of the course

No

structure

String

Structure of the course

No

eligibility

String

Eligibility to Opt for course

No

duration

String

Duration of the Course

No

fee_structure

String

Fee structure

No

programme_details

String

Programme Details

No

programme_coordinator

String

Programme Coordinator

No







3. Organizational Unit


METHOD - GET


USE CASE
To get all the Organizational Unit



REQUEST ATTRIBUTES
API Content format : JSON

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

Parameter

Type

Description

Mandatory

type

String

Type of Organizational Unit ex. Campus, department

NO

id

Number

Id of Organizational Unit

No


by Type
Response

Attribute

Type

Description

Mandatory

type

String

Type Of Organizational Unit

No

name

String

Name of Organizational Unit

No

name_in_hindi

String

Name of Organizational Unit in Hindi

No

name_in_other_language

String

Name of Organizational Unit on another language

No

code

String

Code of Organizational Unit

No

profile

String

Name of Organizational Unit

No

official_email

String

Email of Organizational Unit

No

address_line_1

String

Address Line 1 of Organizational Unit

No

address_line_2

String

Address Line 2 of Organizational Unit

No

address_line_3

String

Address Line 3 of Organizational Unit

No

district

String

District of Organizational Unit

No

city

String

City of Organizational Unit

No

state

String

State of Organizational Unit

No

country

String

Country of Organizational Unit

No

pincode

Number

Pincode of Organizational Unit

No

telephone_number

Number

Tel of Organizational Unit

No

website

String

Website of Organizational Unit

No

facebook_link

String

Facebook Link of Organizational Unit

No

linkedin_link

String

Linkedin

No

twitter_link

String

Twitter

No

logo

String

logo

No












by ID
Response

Attribute

Type

Description

Mandatory

type

String

Type Of Organizational Unit

No

name

String

Name of Organizational Unit

No

name_in_hindi

String

Name of Organizational Unit in Hindi

No

name_in_other_language

String

Name of Organizational Unit in another language

No

code

String

Code of Organizational Unit

No

profile

String

Name of Organizational Unit

No

official_email

String

Email of Organizational Unit

No

address_line_1

String

Address Line 1 of Organizational Unit

No

address_line_2

String

Address Line 2 of Organizational Unit

No

address_line_3

String

Address Line 3 of Organizational Unit

No

district

String

District of Organizational Unit

No

city

String

City of Organizational Unit

No

state

String

State of Organizational Unit

No

country

String

Country of Organizational Unit

No

pincode

Number

Pincode of Organizational Unit

No

telephone_number

Number

Tel of Organizational Unit

No

website

String

Website of Organizational Unit

No

facebook_link

String

Facebook Link of Organizational Unit

No

linkedin_link

String

Linkedin

No

twitter_link

String

Twitter

No

logo

String

logo

No







All Organizational Unit
Response

Attribute

Type

Description

Mandatory

type

String

Type Of Organizational Unit

No

name

String

Name of Organizational Unit

No

name_in_hindi

String

Name of Organizational Unit in Hindi

No

name_in_other_language

String

Name of Organizational Unit in another language

No

code

String

Code of Organizational Unit

No

profile

String

Name of Organizational Unit

No

official_email

String

Email of Organizational Unit

No

address_line_1

String

Address Line 1 of Organizational Unit

No

address_line_2

String

Address Line 2 of Organizational Unit

No

address_line_3

String

Address Line 3 of Organizational Unit

No

district

String

District of Organizational Unit

No

city

String

City of Organizational Unit

No

state

String

State of Organizational Unit

No

country

String

Country of Organizational Unit

No

pincode

Number

Pincode of Organizational Unit

No

telephone_number

Number

Tel of Organizational Unit

No

website

String

Website of Organizational Unit

No

facebook_link

String

Facebook Link of Organizational Unit

No

linkedin_link

String

Linkedin

No

twitter_link

String

Twitter

No

logo

String

logo

No













4. Example - Fetching Employees' Details


METHOD - GET


USE CASE
To get all the employee



REQUEST ATTRIBUTES
API Content format : JSON

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

Parameter

Type

Description

Mandatory

ou

Number

Id of Organizational Unit

NO

designation

Number

Designation Id

No
















By Organizational Unit
REQUEST

Parameter

Type

Description

Mandatory

ou

Number

Id of ou

Yes




Response

Attribute

Type

Description

Mandatory

title

String

Title of Employee

No

first_name

String

First Name of Employee

No

middle_name

String

Middle Name of Employee

No

last_name

String

Last Name of Employee

No

guardian_name

String

Employee Guardian Name

No

mother_name

String

Employee Mother Name

No

marital_status

String

Marital Status of Employee

No

blood_group

String

Blood Group of employee

No

nationality

String

Nationality of Employee

No

date_of_birth

String

DOB of employee

No

mobile_number

String

Mobile of employee

No

personal_email

String

Personal Email of employee

No

employee_type

String

Employee Type

No

nature_of_employment

Number

Nature of Employment

No

organization_unit

Number

Employee Organizational Unit

No

designation

String

Designation of employee

No

employee_code

String

Employee Code

No

ledger_number

String

Employee Ledger

No

date_of_joining

String

Date of Joining

No

qualification

String

Qualification

No

official_email

String

Official Email

No

aadhar_number

String

Aadhar Number

No

official_website

String

Official Website

No

personal_website

String

Personal Website

No

pan_number

String

Pan Number

No

residential_address

Number

Residential Address

No

residential_pincode

Number

Residential Pincode

No

residential_country

String

Residential Country

No

residential_state

String

Residential State

No

residential_city

String

Residential City

No

residential_phone_number

String

Residential Phone Number

No

permanent_address

String

Permanent Address

No

permanent_pincode

String

Permanent Pincode

No

permanent_country

String

Permanent Country

No

permanent_state

String

Permanent State

No

permanent_city

String

Permanent City

No

bank_account_number

String

Bank Account Number

No

bank_name

Number

Bank Name

No

branch_name

Number

Branch Name

No

ifsc_code

String

Ifsc Code

No

photo_upload

String

Photo url

No



By Designation
REQUEST

Parameter

Type

Description

Mandatory

designation

Number

Id of Designation

No



Response

Attribute

Type

Description

Mandatory

title

String

Title of Employee

No

first_name

String

First Name of Employee

No

middle_name

String

Middle Name of Employee

No

last_name

String

Last Name of Employee

No

guardian_name

String

Employee Guardian Name

No

mother_name

String

Employee Mother Name

No

marital_status

String

Marital Status of Employee

No

blood_group

String

Blood Group of employee

No

nationality

String

Nationality of Employee

No

date_of_birth

String

DOB of employee

No

mobile_number

String

Mobile of employee

No

personal_email

String

Personal Email of employee

No

employee_type

String

Employee Type

No

nature_of_employment

Number

Nature of Employment

No

organization_unit

Number

Employee Organizational Unit

No

designation

String

Designation of employee

No

employee_code

String

Employee Code

No

ledger_number

String

Employee Ledger

No

date_of_joining

String

Date of Joining

No

qualification

String

Qualification

No

official_email

String

Official Email

No

aadhar_number

String

Aadhar Number

No

official_website

String

Official Website

No

personal_website

String

Personal Website

No

pan_number

String

Pan Number

No

residential_address

Number

Residential Address

No

residential_pincode

Number

Residential Pincode

No

residential_country

String

Residential Country

No

residential_state

String

Residential State

No

residential_city

String

Residential City

No

residential_phone_number

String

Residential Phone Number

No

permanent_address

String

Permanent Address

No

permanent_pincode

String

Permanent Pincode

No

permanent_country

String

Permanent Country

No

permanent_state

String

Permanent State

No

permanent_city

String

Permanent City

No

bank_account_number

String

Bank Account Number

No

bank_name

Number

Bank Name

No

branch_name

Number

Branch Name

No

ifsc_code

String

Ifsc Code

No

photo_upload

String

Photo url

No




All Employee

Response

Attribute

Type

Description

Mandatory

title

String

Title of Employee

No

first_name

String

First Name of Employee

No

middle_name

String

Middle Name of Employee

No

last_name

String

Last Name of Employee

No

guardian_name

String

Employee Guardian Name

No

mother_name

String

Employee Mother Name

No

marital_status

String

Marital Status of Employee

No

blood_group

String

Blood Group of employee

No

nationality

String

Nationality of Employee

No

date_of_birth

String

DOB of employee

No

mobile_number

String

Mobile of employee

No

personal_email

String

Personal Email of employee

No

employee_type

String

Employee Type

No

nature_of_employment

Number

Nature of Employment

No

organization_unit

Number

Employee Organizational Unit

No

designation

String

Designation of employee

No

employee_code

String

Employee Code

No

ledger_number

String

Employee Ledger

No

date_of_joining

String

Date of Joining

No

qualification

String

Qualification

No

official_email

String

Official Email

No

aadhar_number

String

Aadhar Number

No

official_website

String

Official Website

No

personal_website

String

Personal Website

No

pan_number

String

Pan Number

No

residential_address

Number

Residential Address

No

residential_pincode

Number

Residential Pincode

No

residential_country

String

Residential Country

No

residential_state

String

Residential State

No

residential_city

String

Residential City

No

residential_phone_number

String

Residential Phone Number

No

permanent_address

String

Permanent Address

No

permanent_pincode

String

Permanent Pincode

No

permanent_country

String

Permanent Country

No

permanent_state

String

Permanent State

No

permanent_city

String

Permanent City

No

bank_account_number

String

Bank Account Number

No

bank_name

Number

Bank Name

No

branch_name

Number

Branch Name

No

ifsc_code

String

Ifsc Code

No

photo_upload

String

Photo url

No



By Id
REQUEST

Parameter

Type

Description

Mandatory

id

Number

Employee ID

No



Response

Attribute

Type

Description

Mandatory

title

String

Title of Employee

No

first_name

String

First Name of Employee

No

middle_name

String

Middle Name of Employee

No

last_name

String

Last Name of Employee

No

guardian_name

String

Employee Guardian Name

No

mother_name

String

Employee Mother Name

No

marital_status

String

Marital Status of Employee

No

blood_group

String

Blood Group of employee

No

nationality

String

Nationality of Employee

No

date_of_birth

String

DOB of employee

No

mobile_number

String

Mobile of employee

No

personal_email

String

Personal Email of employee

No

employee_type

String

Employee Type

No

nature_of_employment

Number

Nature of Employment

No

organization_unit

Number

Employee Organizational Unit

No

designation

String

Designation of employee

No

employee_code

String

Employee Code

No

ledger_number

String

Employee Ledger

No

date_of_joining

String

Date of Joining

No

qualification

String

Qualification

No

official_email

String

Official Email

No

aadhar_number

String

Aadhar Number

No

official_website

String

Official Website

No

personal_website

String

Personal Website

No

pan_number

String

Pan Number

No

residential_address

Number

Residential Address

No

residential_pincode

Number

Residential Pincode

No

residential_country

String

Residential Country

No

residential_state

String

Residential State

No

residential_city

String

Residential City

No

residential_phone_number

String

Residential Phone Number

No

permanent_address

String

Permanent Address

No

permanent_pincode

String

Permanent Pincode

No

permanent_country

String

Permanent Country

No

permanent_state

String

Permanent State

No

permanent_city

String

Permanent City

No

bank_account_number

String

Bank Account Number

No

bank_name

Number

Bank Name

No

branch_name

Number

Branch Name

No

ifsc_code

String

Ifsc Code

No

photo_upload

String

Photo url

No


5. Annexure

5.1. Activity Diagram



5.2. Use Case Diagram


  • No labels