/
UPDATE API (PUT)

UPDATE API (PUT)

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

In order to update a product, the user needs to enter the Id of the product (ProductId), which he/she wants to update and any one or more fields (ProductName/ ProductType/ Price).

URL:

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

 

Sample Request Format: JSON (PUT Request)

{ "Id": "2", "ProductName": "Bag" }

In the input request, Id is mandatory in order to update the product.

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 UpdateItemsService class

mp2

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 PUT request. This request is received at the endpoint.

  • The request must be in the specified sample request format with valid product Id.

  • Multiple checks are there to detect any error such as Invalid format of Id/Price or incorrect or missing field names, specifically product Id. 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.

  • In the service layer, the methods are called from the Dao and the value of the respective fields are passed as arguments.

  • Dao interacts with the database and opens the hibernate session and begins the transaction.

  • The item is then updated in the database using the session.update 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 updated 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