/
DELETE API (DELETE)

DELETE API (DELETE)

Owned by Arpita Singh (Unlicensed)
Last updated: Jun 10, 2022
3 min read

In order to delete a product, the user needs to enter one or more fields (Id/ ProductName/ ProductType/ Price).

URL:

https://base-project-testing-dot-eshopbox-test-project.el.r.appspot.com/_ah/api/esb/v1/arpita/del

 

Sample Request Format: JSON (DELETE Request)

{ "ProductName": "Tie", "Price": "200" }

In case if the user enters the Product Id right and any other field wrong, then that particular product will be deleted from the database. This is because the Product Id is defined as the primary key which is unique for every product. On getting the right primary key, the entire row of the product will be deleted.

Variable Description (Endpoint)

Variable

Type

Description

Variable

Type

Description

req

Map <String, Object>

Stores the JSON input request from the user

item

Object

Used to call the methods in DeleteItemsService class

mp3

Map <String, Object>

Stores the API response which is returned to the user.

flag

int

Stores the called function’s return value. Its main purpose is error handling. (For the developer)

e

Exception

Used for exception handling

Program Work-flow

 

  • The user makes a DELETE request. This request is received at the endpoint.

  • The request must be in the specified sample request format.

  • Multiple checks are there to detect any error such as Invalid format of Id/Price or incorrect or missing field names. A proper error message and error code (400: Bad request) are returned back to the user at the endpoint.

  • If the request is valid then the control moves to the service layer through the service interface.

  • If the request contains Id then the service layer calls the deleteProdId method and if it contains any other field other than Id then deleteProd method is called. These methods are in Dao.

  • Dao interacts with the database, begins the transaction and opens the current session. If the value in the input field is not present in the database, then the “Item not found!” message is displayed to the user.

  • If the product is present in the database, a SQL query is executed to delete the product.

  • The query is written using the createSQLQuery method.

  • The transaction is then committed and the session is closed.

  • In case any backend error occurs then a proper message is displayed in the console for the developer. The user also gets an error code in response depending on the type of backend error.

  • All other errors other than InvalidInputException and ResourceNotFound are treated as ApplicationException in this model.

  • If the product is deleted successfully, then the message is displayed along with (200 OK) status code.

Sample Response

Status

  • 200: OK

  • 404: Not found

  • 400: Bad Request

  • 412: Precondition failed

  • 500: Internal Server Error

Feel free to leave any suggestions or comments below!

Related content