shrawnz / maven-ems-aws

Employee Management System Rest API Documentation

http://13.58.24.90:8080/maven-ems-json/

Add Employees

Inserts a new employee into the database;

• URL

  /add
  /addJson (To send parameters as a json in the HTML body)

• Method:

  POST

• URL Params

  Required:

  name=[String] department=[String] email=[String]

• Success Response:

  • Code: 200
    Content: { inserted : true, id: <id> }

• Error Response:

  • Content: { error : <error msg> }

View Employee

View data of a particular employee;

• URL

  /view

• Method:

  GET

• URL Params

  Required:

  id=[String]

• Success Response:

  • Code: 200
    Content: { id: <id>, name: <name>, department: <department>, email: <email> }

• Error Response:

  • Content: { error : <error msg> }

View Employees

View data of all employees;

• URL

  /employees

• Method:

  GET

• URL Params

  None

• Success Response:

  • Code: 200
    Content: [{ id: <id>, name: <name>, department: <department>, email: <email> }]

• Error Response:

  • Content: { error : <error msg> }

Update Employees

Update data of an employee;

• URL

  /update
  /updateJson (To send parameters as a json in the HTML body)

• Method:

  POST

• URL Params

  Required:

  id=[String] name=[String] department=[String] email=[String]

• Success Response:

  • Code: 200
    Content: { updated : true, }

• Error Response:

  • Content: { error : <error msg> }

Delete Employee

Delete data of a particular employee;

• URL

  /delete

• Method:

  POST

• URL Params

  Required:

  id=[String]

• Success Response:

  • Code: 200
    Content: { 'deleted: true' }

• Error Response:

  • Content: { error : <error msg> }