api.coe.clientdigital.io Open in urlscan Pro
159.65.80.143  Public Scan

URL: https://api.coe.clientdigital.io/
Submission: On October 21 via automatic, source certstream-suspicious — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

x
 * Announcements
 * Create announcements
 * Delete announcements
 * Retrieve announcements
 * Retrieve announcements
 * Update announcements
 * Attendance
 * Create attendance
 * Upload attendances
 * Delete student attendance
 * Retrieve DegreeBranch attendance
 * Retrieve student attendance
 * Retrieve student attendance
 * Retrieve student attendance
 * Update student attendance
 * Auth
 * Authenticate
 * Batches
 * Create regulations
 * Delete regulations
 * Retrieve regulations
 * Retrieve regulations
 * Update regulations
 * Branch
 * Create branch
 * Delete branch
 * Delete degree-branches
 * Retrieve branch
 * Retrieve degree-branches
 * Retrieve branch
 * Retrieve branch
 * Retrieve degree-branches
 * Update branch
 * Update degree-branches
 * Categories
 * Create regulations
 * Delete regulations
 * Retrieve regulations
 * Retrieve regulations
 * Update regulations
 * CategoryCredit
 * Create category-credit
 * Delete student category-credit
 * Retrieve student category-credit
 * Retrieve student category-credit
 * Update student category-credit
 * Course
 * Create courses
 * Create courses
 * Create courses
 * Delete courses
 * Retrieve courses
 * Retrieve courses
 * Update courses
 * Degree
 * Create degree
 * Delete degree
 * Retrieve degree
 * Retrieve degree
 * Retrieve degree
 * Update degree
 * DegreeBranches
 * Create degree-branches
 * DegreeCourses
 * Create degreecourses
 * Delete degreecourses
 * Retrieve degreecourses
 * Retrieve degreecourses
 * Retrieve degreecourses
 * Update degreecourses
 * Exams
 * Create exams
 * Delete exams
 * Retrieve exams
 * Retrieve exams
 * Update exams
 * Fees
 * Create fees
 * Delete fees
 * Retrieve fees
 * Retrieve fees
 * Update fees
 * HallTicket
 * Create hall ticket
 * Delete hall ticket
 * Retrieve hall ticket
 * Retrieve hall tickets
 * Update hall ticket
 * InternalMarks
 * Create internalMarks
 * Delete internalMarks
 * Retrieve internalMarks
 * Retrieve internalMarks
 * Update internalMarks
 * Upload internalMarks
 * News
 * Create news
 * Delete news
 * Retrieve news
 * Retrieve news
 * Update news
 * Notifications
 * Create notifications
 * Delete notifications
 * Retrieve notifications
 * Retrieve notifications
 * Update notifications
 * PasswordReset
 * Send email
 * Submit password
 * Verify token
 * QuestionBank
 * Create question bank
 * Delete question bank
 * Retrieve question bank
 * Retrieve question banks
 * Update question bank
 * Regulations
 * Create regulations
 * Delete regulations
 * Retrieve regulations
 * Retrieve regulations
 * Update regulations
 * Result
 * Retrieve internalMarks
 * Retrieve results
 * Results
 * Create results
 * Delete results
 * Retrieve results
 * Retrieve results
 * Update results
 * Upload results
 * Student
 * Create students
 * Create students
 * Delete students
 * Retrieve students
 * Retrieve students
 * Retrieve students
 * Update students
 * Upload students
 * StudentResults
 * Create student results
 * Delete student results
 * Retrieve student results
 * Retrieve student results
 * Update student results
 * Support
 * Create support
 * Delete support
 * Retrieve support
 * Retrieve support
 * Update support
 * User
 * Create user
 * Delete user
 * Retrieve current user
 * Retrieve user
 * Retrieve users
 * Update password
 * Update user


COEAPI


COE APP AND DASHBOARD APIS

0.1.0 
 * Compare all with predecessor
 * 
 * show up to version:
 * 0.1.0
 * 0.0.0





ANNOUNCEMENTS


ANNOUNCEMENTS - CREATE ANNOUNCEMENTS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/announcements

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

announcementTitle

Announcements's announcementTitle.

announcementContent

Announcements's announcementContent.

thumbnail

Announcements's thumbnail.

status

Announcements's status.

createdBy

Announcements's createdBy.


SUCCESS 200

Field Type Description announcements Object

Announcements's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Announcements not found.

401

master access only.


ANNOUNCEMENTS - DELETE ANNOUNCEMENTS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/announcements/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Announcements not found.

401

master access only.


ANNOUNCEMENTS - RETRIEVE ANNOUNCEMENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/announcements/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.


SUCCESS 200

Field Type Description announcements Object

Announcements's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Announcements not found.

401

master access only.


ANNOUNCEMENTS - RETRIEVE ANNOUNCEMENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/announcements

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of announcements.

rows Object[]

List of announcements.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

master access only.


ANNOUNCEMENTS - UPDATE ANNOUNCEMENTS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/announcements/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

announcementTitle

Announcements's announcementTitle.

announcementContent

Announcements's announcementContent.

thumbnail

Announcements's thumbnail.

status

Announcements's status.

createdBy

Announcements's createdBy.


SUCCESS 200

Field Type Description announcements Object

Announcements's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Announcements not found.

401

master access only.


ATTENDANCE


ATTENDANCE - CREATE ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/attendance


PARAMETER

Field Description degree_branch

Student attendance's degree_branch.

semester_no

Student attendance's semester_no.

semester_attendance

Student attendance's semester_attendance.


SUCCESS 200

Field Type Description attendance Object

Student attendance's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student attendance not found.


ATTENDANCE - UPLOAD ATTENDANCES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/attendance


PARAMETER

Field Description degree_branch

Student attendance's degree_branch.

semester_no

Student attendance's semester_no.

semester_attendance

Student attendance's semester_attendance.


SUCCESS 200

Field Type Description attendance Object

Student attendance's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student attendance not found.


ATTENDANCE - DELETE STUDENT ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/attendance/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Student attendance not found.


ATTENDANCE - RETRIEVE DEGREEBRANCH ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/attendance/:degree_branch


SUCCESS 200

Field Type Description attendance Object

DegreeBranch attendance's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

DegreeBranch attendance not found.


ATTENDANCE - RETRIEVE STUDENT ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/attendance/:id


SUCCESS 200

Field Type Description attendance Object

Student attendance's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student attendance not found.


ATTENDANCE - RETRIEVE STUDENT ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/attendance/:id


SUCCESS 200

Field Type Description attendance Object

Student attendance's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student attendance not found.


ATTENDANCE - RETRIEVE STUDENT ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/attendance


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of student attendance.

rows Object[]

List of student attendance.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


ATTENDANCE - UPDATE STUDENT ATTENDANCE

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/attendance/:id


PARAMETER

Field Description degree_branch

Student attendance's degree_branch.

semester_no

Student attendance's semester_no.

semester_attendance

Student attendance's semester_attendance.

isCurrent

Student attendance's isCurrent.


SUCCESS 200

Field Type Description attendance Object

Student attendance's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student attendance not found.


AUTH


AUTH - AUTHENTICATE

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/auth

Permission: master


HEADER

Field Type Description Authorization String

Basic authorization with email and password.


PARAMETER

Field Type Description access_token String

Master access_token.


SUCCESS 201

Field Type Description token String

User access_token to be passed to other requests.

user Object

Current user's data.


ERROR 4XX

Name Description 401

Master access only or invalid credentials.


BATCHES


BATCHES - CREATE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/regulations

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

batch_year

Batches's batch_year.

batch_code

Batches's batch_code.

passed_out_arrears

Batches's passed_out_arrears.

follow_cbcs

Batches's follow_cbcs.

status

Batches's status.

createdBy

Batches's createdBy.


SUCCESS 200

Field Type Description regulations Object

Batches's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Batches not found.

401

admin access only.


BATCHES - DELETE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Batches not found.

401

admin access only.


BATCHES - RETRIEVE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/regulations

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of regulations.

rows Object[]

List of regulations.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


BATCHES - RETRIEVE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description regulations Object

Batches's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Batches not found.

401

admin access only.


BATCHES - UPDATE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

batch_year

Batches's batch_year.

batch_code

Batches's batch_code.

passed_out_arrears

Batches's passed_out_arrears.

follow_cbcs

Batches's follow_cbcs.

status

Batches's status.

createdBy

Batches's createdBy.


SUCCESS 200

Field Type Description regulations Object

Batches's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Batches not found.

401

admin access only.


BRANCH


BRANCH - CREATE BRANCH

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/branch

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

branch_name

Branch's branch_name.

branch_code

Branch's branch_code.

no_of_semesters

Branch's no_of_semesters.

Branch

's.

status

Branch's status.

createdBy

Branch's createdBy.


SUCCESS 200

Field Type Description branch Object

Branch's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Branch not found.

401

admin access only.


BRANCH - DELETE BRANCH

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/branch/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Branch not found.

401

admin access only.


BRANCH - DELETE DEGREE-BRANCHES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/degree-branches/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Branch not found.

401

admin access only.


BRANCH - RETRIEVE BRANCH

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/branch

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of branch.

rows Object[]

List of branch.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


BRANCH - RETRIEVE DEGREE-BRANCHES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree-branches/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description degree-branches Object

Branch's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Branch not found.

401

admin access only.


BRANCH - RETRIEVE BRANCH

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/branch/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description branch Object

Branch's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Branch not found.

401

admin access only.


BRANCH - RETRIEVE BRANCH

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/branch/:branch_name

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description branch Object

Branch's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Branch not found.

401

admin access only.


BRANCH - RETRIEVE DEGREE-BRANCHES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree-branches

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of degree-branches.

rows Object[]

List of degree-branches.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


BRANCH - UPDATE BRANCH

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/branch/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

branch_name

Branch's branch_name.

branch_code

Branch's branch_code.

Branch

's.

status

Branch's status.

createdBy

Branch's createdBy.


SUCCESS 200

Field Type Description branch Object

Branch's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Branch not found.

401

admin access only.


BRANCH - UPDATE DEGREE-BRANCHES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/degree-branches/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

degree_id

Branch's degree_id.

branch_id

Branch's branch_id.

Branch

's.

status

Branch's status.

createdBy

Branch's createdBy.


SUCCESS 200

Field Type Description degree-branches Object

Branch's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Branch not found.

401

admin access only.


CATEGORIES


CATEGORIES - CREATE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/regulations

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

category_name

Categories's category_name.

category_short_name

Categories's category_short_name.

Categories

's.

status

Categories's status.

createdBy

Categories's createdBy.


SUCCESS 200

Field Type Description regulations Object

Categories's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Categories not found.

401

admin access only.


CATEGORIES - DELETE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Categories not found.

401

admin access only.


CATEGORIES - RETRIEVE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description regulations Object

Categories's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Categories not found.

401

admin access only.


CATEGORIES - RETRIEVE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/regulations

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of regulations.

rows Object[]

List of regulations.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


CATEGORIES - UPDATE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

category_name

Categories's category_name.

category_short_name

Categories's category_short_name.

Categories

's.

status

Categories's status.

createdBy

Categories's createdBy.


SUCCESS 200

Field Type Description regulations Object

Categories's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Categories not found.

401

admin access only.


CATEGORYCREDIT


CATEGORYCREDIT - CREATE CATEGORY-CREDIT

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/category-credits


PARAMETER

Field Description branch_id

CategoryCredit's branch_id.

categorywise_credits

CategoryCredit's categorywise_credits.


SUCCESS 200

Field Type Description category-credit Object

CategoryCredit's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

category-credit not found.


CATEGORYCREDIT - DELETE STUDENT CATEGORY-CREDIT

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/category-credits/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

category-credit not found.


CATEGORYCREDIT - RETRIEVE STUDENT CATEGORY-CREDIT

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/category-credits/:id


SUCCESS 200

Field Type Description category-credit Object

CategoryCredit's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

category-credit not found.


CATEGORYCREDIT - RETRIEVE STUDENT CATEGORY-CREDIT

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/category-credits


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of student category-credit.

rows Object[]

List of student category-credit.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


CATEGORYCREDIT - UPDATE STUDENT CATEGORY-CREDIT

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/category-credits/:id


PARAMETER

Field Description branch_id

CategoryCredit's branch_id.

categorywise_credits

CategoryCredit's categorywise_credits.

isCurrent

CategoryCredit's isCurrent.


SUCCESS 200

Field Type Description category-credit Object

CategoryCredit's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

category-credit not found.


COURSE


COURSE - CREATE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/courses

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

course_type

Course's course_type.

course_requirement

Course's course_requirement.

course_category

Course's course_category.

course_name

Course's course_name.

course_code

Course's course_code.

no_of_credits

Course's no_of_credits.

status

Course's status.

created_by

Course's created_by.


SUCCESS 200

Field Type Description courses Object

Course's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Course not found.

401

admin access only.


COURSE - CREATE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/courses

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

course_type

Course's course_type.

course_requirement

Course's course_requirement.

course_category

Course's course_category.

course_name

Course's course_name.

course_code

Course's course_code.

no_of_credits

Course's no_of_credits.

status

Course's status.

created_by

Course's created_by.


SUCCESS 200

Field Type Description courses Object

Course's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Course not found.

401

admin access only.


COURSE - CREATE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/courses

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

course_type

Course's course_type.

course_requirement

Course's course_requirement.

course_category

Course's course_category.

course_name

Course's course_name.

course_code

Course's course_code.

no_of_credits

Course's no_of_credits.

status

Course's status.

created_by

Course's created_by.


SUCCESS 200

Field Type Description courses Object

Course's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Course not found.

401

admin access only.


COURSE - DELETE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/courses/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Course not found.

401

admin access only.


COURSE - RETRIEVE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/courses

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of courses.

rows Object[]

List of courses.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


COURSE - RETRIEVE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/courses/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description courses Object

Course's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Course not found.

401

admin access only.


COURSE - UPDATE COURSES

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/courses/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

course_type

Course's course_type.

course_requirement

Course's course_requirement.

course_category

Course's course_category.

course_name

Course's course_name.

course_code

Course's course_code.

no_of_credits

Course's no_of_credits.

status

Course's status.

created_by

Course's created_by.


SUCCESS 200

Field Type Description courses Object

Course's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Course not found.

401

admin access only.


DEGREE


DEGREE - CREATE DEGREE

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/degree

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

degree_name

Degree's degree_name.

degree_type

Degree's degree_type.

degree_code

Degree's degree_code.

no_of_semesters

Degree's no_of_semesters.

Degree

's.

status

Degree's status.

createdBy

Degree's createdBy.


SUCCESS 200

Field Type Description degree Object

Degree's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Degree not found.

401

admin access only.


DEGREE - DELETE DEGREE

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/degree/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Degree not found.

401

admin access only.


DEGREE - RETRIEVE DEGREE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree/getDegreeByCode:degree_code

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description degree Object

Degree's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Degree not found.

401

admin access only.


DEGREE - RETRIEVE DEGREE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description degree Object

Degree's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Degree not found.

401

admin access only.


DEGREE - RETRIEVE DEGREE

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of degree.

rows Object[]

List of degree.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


DEGREE - UPDATE DEGREE

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/degree/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

degree_name

Degree's degree_name.

degree_type

Degree's degree_type.

degree_code

Degree's degree_code.

Degree

's.

status

Degree's status.

createdBy

Degree's createdBy.


SUCCESS 200

Field Type Description degree Object

Degree's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Degree not found.

401

admin access only.


DEGREEBRANCHES


DEGREEBRANCHES - CREATE DEGREE-BRANCHES

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/degree-branches

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

degree_id

DegreeBranches's degree_id.

branch_id

DegreeBranches's branch_id.

DegreeBranches

's.

status

DegreeBranches's status.

createdBy

DegreeBranches's createdBy.


SUCCESS 200

Field Type Description degree-branches Object

DegreeBranches's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

DegreeBranches not found.

401

admin access only.


DEGREECOURSES


DEGREECOURSES - CREATE DEGREECOURSES

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/degree-courses


PARAMETER

Field Description regulation

DegreeCourses's regulation.

degree

DegreeCourses's degree.

branch

DegreeCourses's branch.

semester

DegreeCourses's semester.

courseList

DegreeCourses's courseList.

createdBy

DegreeCourses's createdBy.


SUCCESS 200

Field Type Description degreecourses Object

DegreeCourses's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

DegreeCourses not found.


DEGREECOURSES - DELETE DEGREECOURSES

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/degree-courses/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

DegreeCourses not found.


DEGREECOURSES - RETRIEVE DEGREECOURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree-courses/getDegreeCoursesByBranch/:


SUCCESS 200

Field Type Description degreecourses Object

DegreeCourses's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

DegreeCourses not found.


DEGREECOURSES - RETRIEVE DEGREECOURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree-courses/:id


SUCCESS 200

Field Type Description degreecourses Object

DegreeCourses's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

DegreeCourses not found.


DEGREECOURSES - RETRIEVE DEGREECOURSES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/degree-courses


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of degreecourses.

rows Object[]

List of degreecourses.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


DEGREECOURSES - UPDATE DEGREECOURSES

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/degree-courses/:id


PARAMETER

Field Description regulation

DegreeCourses's regulation.

degree

DegreeCourses's degree.

branch

DegreeCourses's branch.

semester

DegreeCourses's semester.

courseList

DegreeCourses's courseList.

createdBy

DegreeCourses's createdBy.


SUCCESS 200

Field Type Description degreecourses Object

DegreeCourses's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

DegreeCourses not found.


EXAMS


EXAMS - CREATE EXAMS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/exams


PARAMETER

Field Description degree

Exams's degree.

batch

Exams's batch.

branch

Exams's branch.

examName

Exams's examName.

examDate

Exams's examDate.

examStatus

Exams's examStatus.

academicYear

Exams's academicYear.

semester

Exams's semester.

createdBy

Exams's createdBy.


SUCCESS 200

Field Type Description exams Object

Exams's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Exams not found.


EXAMS - DELETE EXAMS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/exams/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Exams not found.


EXAMS - RETRIEVE EXAMS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/exams


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of exams.

rows Object[]

List of exams.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


EXAMS - RETRIEVE EXAMS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/exams/:id


SUCCESS 200

Field Type Description exams Object

Exams's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Exams not found.


EXAMS - UPDATE EXAMS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/exams/:id


PARAMETER

Field Description degree

Exams's degree.

batch

Exams's batch.

branch

Exams's branch.

examName

Exams's examName.

examDate

Exams's examDate.

examStatus

Exams's examStatus.

academicYear

Exams's academicYear.

semester

Exams's semester.

createdBy

Exams's createdBy.


SUCCESS 200

Field Type Description exams Object

Exams's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Exams not found.


FEES


FEES - CREATE FEES

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/fees

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

feeDescription

Fees's feeDescription.

amount

Fees's amount.

status

Fees's status.


SUCCESS 200

Field Type Description fees Object

Fees's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Fees not found.

401

master access only.


FEES - DELETE FEES

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/fees/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Fees not found.


FEES - RETRIEVE FEES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/fees/:id


SUCCESS 200

Field Type Description fees Object

Fees's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Fees not found.


FEES - RETRIEVE FEES

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/fees


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of fees.

rows Object[]

List of fees.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


FEES - UPDATE FEES

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/fees/:id


PARAMETER

Field Description feeDescription

Fees's feeDescription.

amount

Fees's amount.

status

Fees's status.


SUCCESS 200

Field Type Description fees Object

Fees's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Fees not found.


HALLTICKET


HALLTICKET - CREATE HALL TICKET

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/hall-tickets


PARAMETER

Field Description hallTicketTitle

Hall ticket's hallTicketTitle.

examId

Hall ticket's examId.

studentName

Hall ticket's studentName.

studentEmail

Hall ticket's studentEmail.

status

Hall ticket's status.


SUCCESS 200

Field Type Description hallTicket Object

Hall ticket's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Hall ticket not found.


HALLTICKET - DELETE HALL TICKET

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/hall-tickets/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Hall ticket not found.


HALLTICKET - RETRIEVE HALL TICKET

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/hall-tickets/:id


SUCCESS 200

Field Type Description hallTicket Object

Hall ticket's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Hall ticket not found.


HALLTICKET - RETRIEVE HALL TICKETS

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/hall-tickets


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of hall tickets.

rows Object[]

List of hall tickets.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


HALLTICKET - UPDATE HALL TICKET

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/hall-tickets/:id


PARAMETER

Field Description hallTicketTitle

Hall ticket's hallTicketTitle.

examId

Hall ticket's examId.

studentName

Hall ticket's studentName.

studentEmail

Hall ticket's studentEmail.

status

Hall ticket's status.


SUCCESS 200

Field Type Description hallTicket Object

Hall ticket's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Hall ticket not found.


INTERNALMARKS


INTERNALMARKS - CREATE INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/internal-marks

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

roll_no

InternalMarks's roll_no.

batch

InternalMarks's batch.

degree_branch

InternalMarks's degree_branch.

sem_no

InternalMarks's sem_no.

section

InternalMarks's section.

student_name

InternalMarks's student_name.

markDetails

InternalMarks's markDetails.

status

InternalMarks's status.

createdDate

InternalMarks's createdDate.

createdBy

InternalMarks's createdBy.

modifiedDate

InternalMarks's modifiedDate.

modifiedBy

InternalMarks's modifiedBy.


SUCCESS 200

Field Type Description internalMarks Object

InternalMarks's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

InternalMarks not found.

401

master access only.


INTERNALMARKS - DELETE INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/internal-marks/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

InternalMarks not found.

401

master access only.


INTERNALMARKS - RETRIEVE INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/internal-marks

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of internalMarks.

rows Object[]

List of internalMarks.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

master access only.


INTERNALMARKS - RETRIEVE INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/internal-marks/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.


SUCCESS 200

Field Type Description internalMarks Object

InternalMarks's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

InternalMarks not found.

401

master access only.


INTERNALMARKS - UPDATE INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/internal-marks/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

roll_no

InternalMarks's roll_no.

student_name

InternalMarks's student_name.

degree_branch

InternalMarks's degree_branch.

course_code

InternalMarks's course_code.

course_name

InternalMarks's course_name.

no_of_credits

InternalMarks's no_of_credits.

sem_no

InternalMarks's sem_no.

letter_grade

InternalMarks's letter_grade.

result

InternalMarks's result.

gpa

InternalMarks's gpa.

cgpa

InternalMarks's cgpa.

status

InternalMarks's status.

createdBy

InternalMarks's createdBy.

modifiedBy

InternalMarks's modifiedBy.


SUCCESS 200

Field Type Description internalMarks Object

InternalMarks's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

InternalMarks not found.

401

master access only.


INTERNALMARKS - UPLOAD INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/internal-marks

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

roll_no

InternalMarks's roll_no.

batch

InternalMarks's batch.

degree_branch

InternalMarks's degree_branch.

sem_no

InternalMarks's sem_no.

section

InternalMarks's section.

student_name

InternalMarks's student_name.

markDetails

InternalMarks's markDetails.

status

InternalMarks's status.

createdDate

InternalMarks's createdDate.

createdBy

InternalMarks's createdBy.

modifiedDate

InternalMarks's modifiedDate.

modifiedBy

InternalMarks's modifiedBy.


SUCCESS 200

Field Type Description internalMarks Object

InternalMarks's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

InternalMarks not found.

401

master access only.


NEWS


NEWS - CREATE NEWS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/news

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

newsTitle

News's newsTitle.

newsDate

News's newsDate.

status

News's status.

newsContent

News's newsContent.

newsThumb

News's newsThumb.

createdBy

News's createdBy.


SUCCESS 200

Field Type Description news Object

News's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

News not found.

401

admin access only.


NEWS - DELETE NEWS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/news/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

News not found.

401

admin access only.


NEWS - RETRIEVE NEWS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/news/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description news Object

News's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

News not found.

401

admin access only.


NEWS - RETRIEVE NEWS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/news

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of news.

rows Object[]

List of news.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


NEWS - UPDATE NEWS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/news/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

newsTitle

News's newsTitle.

newsDate

News's newsDate.

status

News's status.

newsContent

News's newsContent.

newsThumb

News's newsThumb.

createdBy

News's createdBy.


SUCCESS 200

Field Type Description news Object

News's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

News not found.

401

admin access only.


NOTIFICATIONS


NOTIFICATIONS - CREATE NOTIFICATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/notifications


PARAMETER

Field Description user_id

Notifications's user_id.

subscription_id

Notifications's subscription_id.


SUCCESS 200

Field Type Description notifications Object

Notifications's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Notifications not found.


NOTIFICATIONS - DELETE NOTIFICATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/notifications/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Notifications not found.


NOTIFICATIONS - RETRIEVE NOTIFICATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/notifications/:id


SUCCESS 200

Field Type Description notifications Object

Notifications's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Notifications not found.


NOTIFICATIONS - RETRIEVE NOTIFICATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/notifications

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of notifications.

rows Object[]

List of notifications.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


NOTIFICATIONS - UPDATE NOTIFICATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/notifications/:id


PARAMETER

Field Description user_id

Notifications's user_id.

subscription_id

Notifications's subscription_id.


SUCCESS 200

Field Type Description notifications Object

Notifications's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Notifications not found.


PASSWORDRESET


PASSWORDRESET - SEND EMAIL

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/password-resets

Permission: master


PARAMETER

Field Type Description email String

Email address to receive the password reset token.

link String

Link to redirect user.


SUCCESS 202

Field Description 202

Accepted.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


PASSWORDRESET - SUBMIT PASSWORD

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/password-resets/:token


PARAMETER

Field Type Description password String

User's new password.

Size range: 6..


SUCCESS 200

Field Type Description user Object

User's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Token has expired or doesn't exist.


PASSWORDRESET - VERIFY TOKEN

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/password-resets/:token


SUCCESS 200

Field Type Description token String

Password reset token.

user Object

User's data.


ERROR 4XX

Name Description 404

Token has expired or doesn't exist.


QUESTIONBANK


QUESTIONBANK - CREATE QUESTION BANK

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/question-banks


PARAMETER

Field Description title

Question bank's title.

semester

Question bank's semester.

degree

Question bank's degree.

batch

Question bank's batch.

branch

Question bank's branch.

status

Question bank's status.

attachments

Question bank's attachments.


SUCCESS 200

Field Type Description questionBank Object

Question bank's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Question bank not found.


QUESTIONBANK - DELETE QUESTION BANK

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/question-banks/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Question bank not found.


QUESTIONBANK - RETRIEVE QUESTION BANK

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/question-banks/:id


SUCCESS 200

Field Type Description questionBank Object

Question bank's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Question bank not found.


QUESTIONBANK - RETRIEVE QUESTION BANKS

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/question-banks


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of question banks.

rows Object[]

List of question banks.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


QUESTIONBANK - UPDATE QUESTION BANK

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/question-banks/:id


PARAMETER

Field Description title

Question bank's title.

semester

Question bank's semester.

degree

Question bank's degree.

batch

Question bank's batch.

branch

Question bank's branch.

status

Question bank's status.

attachments

Question bank's attachments.


SUCCESS 200

Field Type Description questionBank Object

Question bank's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Question bank not found.


REGULATIONS


REGULATIONS - CREATE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/regulations

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

regulation_year

Regulations's regulation_year.

regulation_code

Regulations's regulation_code.

min_internal

Regulations's min_internal.

min_external

Regulations's min_external.

min_attendance

Regulations's min_attendance.

min_course_attendance

Regulations's min_course_attendance.

min_total

Regulations's min_total.

max_internal

Regulations's max_internal.

max_external

Regulations's max_external.

max_total

Regulations's max_total.

max_qp_marks

Regulations's max_qp_marks.

condonation_range_start

Regulations's condonation_range_start.

status

Regulations's status.

createdBy

Regulations's createdBy.


SUCCESS 200

Field Type Description regulations Object

Regulations's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Regulations not found.

401

admin access only.


REGULATIONS - DELETE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Regulations not found.

401

admin access only.


REGULATIONS - RETRIEVE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/regulations

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of regulations.

rows Object[]

List of regulations.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


REGULATIONS - RETRIEVE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description regulations Object

Regulations's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Regulations not found.

401

admin access only.


REGULATIONS - UPDATE REGULATIONS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/regulations/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

regulation_year

Regulations's regulation_year.

regulation_code

Regulations's regulation_code.

min_internal

Regulations's min_internal.

min_external

Regulations's min_external.

min_attendance

Regulations's min_attendance.

min_course_attendance

Regulations's min_course_attendance.

min_total

Regulations's min_total.

max_internal

Regulations's max_internal.

max_external

Regulations's max_external.

max_total

Regulations's max_total.

max_qp_marks

Regulations's max_qp_marks.

condonation_range_start

Regulations's condonation_range_start.

status

Regulations's status.

createdBy

Regulations's createdBy.


SUCCESS 200

Field Type Description regulations Object

Regulations's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Regulations not found.

401

admin access only.


RESULT


RESULT - RETRIEVE INTERNALMARKS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/getInternalMarksByRollNo/:roll_no

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description internalMarks Object

Result's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Result not found.

401

admin access only.


RESULT - RETRIEVE RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/checkResult/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description results Object

Result's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Result not found.

401

admin access only.


RESULTS


RESULTS - CREATE RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/results

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

roll_no

Results's roll_no.

student_name

Results's student_name.

degree_branch

Results's degree_branch.

course_code

Results's course_code.

course_name

Results's course_name.

no_of_credits

Results's no_of_credits.

sem_no

Results's sem_no.

letter_grade

Results's letter_grade.

result

Results's result.

gpa

Results's gpa.

cgpa

Results's cgpa.

status

Results's status.

createdDate

Results's createdDate.

createdBy

Results's createdBy.

modifiedDate

Results's modifiedDate.

modifiedBy

Results's modifiedBy.


SUCCESS 200

Field Type Description results Object

Results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Results not found.

401

master access only.


RESULTS - DELETE RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/results/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Results not found.

401

master access only.


RESULTS - RETRIEVE RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/results

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of results.

rows Object[]

List of results.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

master access only.


RESULTS - RETRIEVE RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/results/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.


SUCCESS 200

Field Type Description results Object

Results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Results not found.

401

master access only.


RESULTS - UPDATE RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/results/:id

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

roll_no

Results's roll_no.

student_name

Results's student_name.

degree_branch

Results's degree_branch.

course_code

Results's course_code.

course_name

Results's course_name.

no_of_credits

Results's no_of_credits.

sem_no

Results's sem_no.

letter_grade

Results's letter_grade.

result

Results's result.

gpa

Results's gpa.

cgpa

Results's cgpa.

status

Results's status.

createdBy

Results's createdBy.

modifiedBy

Results's modifiedBy.


SUCCESS 200

Field Type Description results Object

Results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Results not found.

401

master access only.


RESULTS - UPLOAD RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/results

Permission: master


PARAMETER

Field Type Description access_token String

master access token.

roll_no

Results's roll_no.

student_name

Results's student_name.

degree_branch

Results's degree_branch.

course_code

Results's course_code.

course_name

Results's course_name.

no_of_credits

Results's no_of_credits.

sem_no

Results's sem_no.

letter_grade

Results's letter_grade.

result

Results's result.

gpa

Results's gpa.

cgpa

Results's cgpa.

status

Results's status.

createdDate

Results's createdDate.

createdBy

Results's createdBy.

modifiedDate

Results's modifiedDate.

modifiedBy

Results's modifiedBy.


SUCCESS 200

Field Type Description results Object

Results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Results not found.

401

master access only.


STUDENT


STUDENT - CREATE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/students

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

app_no

Student's app_no.

application_no

Student's application_no.

batch

Student's batch.

degree

Student's degree.

branch

Student's branch.

semester

Student's semester.

seat_type

Student's seat_type.

student_name

Student's student_name.

dob

Student's dob.

gender

Student's gender.

student_email

Student's student_email.

student_mobile

Student's student_mobile.

parent_email

Student's parent_email.

parent_mobile

Student's parent_mobile.

blood_group

Student's blood_group.

roll_no

Student's roll_no.

address

Student's address.

street

Student's street.

state

Student's state.

city

Student's city.

pincode

Student's pincode.

country

Student's country.

status

Student's status.

created_by

Student's created_by.


SUCCESS 200

Field Type Description students Object

Student's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student not found.

401

admin access only.


STUDENT - CREATE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/students

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

app_no

Student's app_no.

application_no

Student's application_no.

batch

Student's batch.

degree

Student's degree.

branch

Student's branch.

semester

Student's semester.

seat_type

Student's seat_type.

student_name

Student's student_name.

dob

Student's dob.

gender

Student's gender.

student_email

Student's student_email.

student_mobile

Student's student_mobile.

parent_email

Student's parent_email.

parent_mobile

Student's parent_mobile.

blood_group

Student's blood_group.

roll_no

Student's roll_no.

address

Student's address.

street

Student's street.

state

Student's state.

city

Student's city.

pincode

Student's pincode.

country

Student's country.

status

Student's status.

created_by

Student's created_by.


SUCCESS 200

Field Type Description students Object

Student's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student not found.

401

admin access only.


STUDENT - DELETE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/students/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Student not found.

401

admin access only.


STUDENT - RETRIEVE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/students

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of students.

rows Object[]

List of students.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


STUDENT - RETRIEVE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/students/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description students Object

Student's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student not found.

401

admin access only.


STUDENT - RETRIEVE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/checkStudent/:roll_no

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description students Object

Student's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student not found.

401

admin access only.


STUDENT - UPDATE STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/students/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

app_no

Student's app_no.

application_no

Student's application_no.

batch

Student's batch.

degree

Student's degree.

branch

Student's branch.

semester

Student's semester.

seat_type

Student's seat_type.

student_name

Student's student_name.

dob

Student's dob.

gender

Student's gender.

student_email

Student's student_email.

student_mobile

Student's student_mobile.

parent_email

Student's parent_email.

parent_mobile

Student's parent_mobile.

blood_group

Student's blood_group.

roll_no

Student's roll_no.

address

Student's address.

street

Student's street.

state

Student's state.

city

Student's city.

pincode

Student's pincode.

country

Student's country.

status

Student's status.

created_by

Student's created_by.


SUCCESS 200

Field Type Description students Object

Student's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student not found.

401

admin access only.


STUDENT - UPLOAD STUDENTS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/students

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

app_no

Student's app_no.

application_no

Student's application_no.

batch

Student's batch.

degree

Student's degree.

branch

Student's branch.

semester

Student's semester.

seat_type

Student's seat_type.

student_name

Student's student_name.

dob

Student's dob.

gender

Student's gender.

student_email

Student's student_email.

student_mobile

Student's student_mobile.

parent_email

Student's parent_email.

parent_mobile

Student's parent_mobile.

blood_group

Student's blood_group.

roll_no

Student's roll_no.

address

Student's address.

street

Student's street.

state

Student's state.

city

Student's city.

pincode

Student's pincode.

country

Student's country.

status

Student's status.

created_by

Student's created_by.


SUCCESS 200

Field Type Description students Object

Student's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student not found.

401

admin access only.


STUDENTRESULTS


STUDENTRESULTS - CREATE STUDENT RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/student-results


PARAMETER

Field Description resultId

Student results's resultId.

studentName

Student results's studentName.

studentEmail

Student results's studentEmail.

resultData

Student results's resultData.

semester

Student results's semester.

course

Student results's course.

batch

Student results's batch.


SUCCESS 200

Field Type Description studentResults Object

Student results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student results not found.


STUDENTRESULTS - DELETE STUDENT RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/student-results/:id


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Student results not found.


STUDENTRESULTS - RETRIEVE STUDENT RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/student-results


PARAMETER

Field Type Description q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of student results.

rows Object[]

List of student results.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.


STUDENTRESULTS - RETRIEVE STUDENT RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/student-results/:id


SUCCESS 200

Field Type Description studentResults Object

Student results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student results not found.


STUDENTRESULTS - UPDATE STUDENT RESULTS

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/student-results/:id


PARAMETER

Field Description resultId

Student results's resultId.

studentName

Student results's studentName.

studentEmail

Student results's studentEmail.

resultData

Student results's resultData.

semester

Student results's semester.

course

Student results's course.

batch

Student results's batch.

isCurrent

Student results's isCurrent.


SUCCESS 200

Field Type Description studentResults Object

Student results's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Student results not found.


SUPPORT


SUPPORT - CREATE SUPPORT

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/support

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

ticket_no

Support's ticket_no.

related_to

Support's related_to.

message

Support's message.

report_from

Support's report_from.

comments

Support's comments.

status

Support's status.

createdDate

Support's createdDate.

createdBy

Support's createdBy.


SUCCESS 200

Field Type Description support Object

Support's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Support not found.

401

admin access only.


SUPPORT - DELETE SUPPORT

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/support/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 404

Support not found.

401

admin access only.


SUPPORT - RETRIEVE SUPPORT

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/support

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description count Number

Total amount of support.

rows Object[]

List of support.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

admin access only.


SUPPORT - RETRIEVE SUPPORT

0.0.0 
 * compare changes to:
 * 0.0.0
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/support/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.


SUCCESS 200

Field Type Description support Object

Support's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Support not found.

401

admin access only.


SUPPORT - UPDATE SUPPORT

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/support/:id

Permission: admin


PARAMETER

Field Type Description access_token String

admin access token.

ticket_no

Support's ticket_no.

related_to

Support's related_to.

message

Support's message.

report_from

Support's report_from.

comments

Support's comments.

status

Support's status.

createdDate

Support's createdDate.

createdBy

Support's createdBy.


SUCCESS 200

Field Type Description support Object

Support's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

404

Support not found.

401

admin access only.


USER


USER - CREATE USER

0.0.0 
 * compare changes to:
 * 0.0.0


post

http://api.coe.clientdigital.io:9000/users

Permission: master


PARAMETER

Field Type Description access_token String

Master access_token.

email String

User's email.

password String

User's password.

Size range: 6..

name optional String

User's name.

picture optional String

User's picture.

role optional String

User's role.

Default value: user

Allowed values: user, admin

rollNo optional String

User's roleNo.


SUCESS 201

Field Type Description user Object

User's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

Master access only.

409

Email already registered.


USER - DELETE USER

0.0.0 
 * compare changes to:
 * 0.0.0


delete

http://api.coe.clientdigital.io:9000/users/:id

Permission: admin


PARAMETER

Field Type Description access_token String

User access_token.


SUCCESS 204

Field Description 204

No Content.


ERROR 4XX

Name Description 401

Admin access only.

404

User not found.


USER - RETRIEVE CURRENT USER

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/users/me

Permission: user


PARAMETER

Field Type Description access_token String

User access_token.


SUCCESS 200

Field Type Description user Object

User's data.


USER - RETRIEVE USER

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/users/:id

Permission: public


SUCCESS 200

Field Type Description user Object

User's data.


ERROR 4XX

Name Description 404

User not found.


USER - RETRIEVE USERS

0.0.0 
 * compare changes to:
 * 0.0.0


get

http://api.coe.clientdigital.io:9000/users

Permission: admin


PARAMETER

Field Type Description access_token String

User access_token.

q optional String

Query to search.

page optional Number

Page number.

Default value: 1

Size range: 1..30

limit optional Number

Amount of returned items.

Default value: 30

Size range: 1..100

sort optional String[]

Order of returned items.

Default value: -createdAt

fields optional String[]

Fields to be returned.


SUCCESS 200

Field Type Description users Object[]

List of users.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

Admin access only.


USER - UPDATE PASSWORD

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/users/:id/password


HEADER

Field Type Description Authorization String

Basic authorization with email and password.


PARAMETER

Field Type Description password String

User's new password.

Size range: 6..


SUCCESS 201

Field Type Description user Object

User's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

Current user access only.

404

User not found.


USER - UPDATE USER

0.0.0 
 * compare changes to:
 * 0.0.0


put

http://api.coe.clientdigital.io:9000/users/:id

Permission: user


PARAMETER

Field Type Description access_token String

User access_token.

name optional String

User's name.

rollNo optional String

User's rollNo.

picture optional String

User's picture.


SUCCESS 200

Field Type Description user Object

User's data.


ERROR 4XX

Name Type Description 400 Object

Some parameters may contain invalid values.

401

Current user or admin access only.

404

User not found.


Generated with apidoc 0.17.7 - 2019-08-07T02:10:54.506Z