CODEWITHSUNDEEP
restresteasy
mad_fox
mad_fox

Reputation: 3198

REST Partial update with several fields

Lets say I have a rest service that allows applications to create User object

URI: /users
HTTP Method:POST

{
   "firstName":"Edward",
   "lastName": "Nygma",
   "dob": "01011981",
   "email": "[email protected]",
   "phone": "0123456789"
}

On the first POST the User object is created and and the User ID is returned

Lets say there is a second service that allows the user to update the lastName and email fields.

URI: /user/1/last-email

HTTP Method: POST

{
   "lastName": "scissorhands",
   "email": "[email protected]"
}

Let's say for the sake of bandwidth sending the full User object is not an option for this update call.

Is this the correct way to do a partial update that involves several fields? Also using PATCH is out of the question.

Edit: I know that the correct way to do this restfully would be to post an update to each field as a sub resource but lets say for the sake of bandwidth/business requirements that this update has to be done in a single call. Is this the correct way to do so?

Edit 2:

Our implementation does not support the HTTP PATCH method, hence why I indicated in the initial question that using patch is out of the question. That being said, maybe I should rephrase the question.

Since system/business requirements prevent us from implementing this correctly in a RESTful manor. What is the best way to handle this scenario.

Upvotes: 2

Views: 2578

Answers (1)

Kinjo
Kinjo

Reputation: 1456

Putting the verb "update-" suddenly makes it feel like it's an RPC call. What do you do when you want to delete this email? Doing a DELETE action on this URI looks a bit silly.

URI: /user/1/email and URI: user/1/lastname would make more sense as EMAIL would just be a subresource and you can use all the verbs on those resources.

Yes, this would take 2 calls in case you want to update 2 resources instead of 1.

For partial updates of a resource use "PATCH" verb on the resource. This way you would not need a new URI at all. (Best practice for partial updates in a RESTful service)

Reference: http://restcookbook.com/HTTP%20Methods/patch/

Quote:

When should we use the PATCH HTTP method?

The HTTP methods PATCH can be used to update partial resources. For instance, when you only need to update one field of the resource, PUTting a complete resource representation might be cumbersome and utilizes more bandwidth

Upvotes: 1

Related Questions