rest - HTTP PATCH method. Content in the request body -


i'm developping rest api using symfony2. have reservation system , send email customer when reservation validate admin.

i have reservation ressource, , can validate reservation using url :

patch localhost/:id/validate

i want know if correct put email content request body when validate ressource, using patch method.

if no, should correct way ?

thanks, mehdi.

first, resources , rest.

when patch localhost/:id/validate should read "i updating existing validate". "a validate" nothing, not proper english. validate not resource, action. when have actions (verbs) in url, api rpc, not rest. see my longer answer here.

so, consider really doing. 1 of below:

  • you updating reservation
  • you creating validation on reservation
  • you replacing reservation validated version of reservation.

the first make sense , simplest.
patch /reservations/{id} status=valid
reservation hold email-adddress? use that. otherwise consider sending email along.
patch /reservations/{id} status=valid&email=foo@example.com.
reads "update reservation email , status following values". since patch (and post) may have side-effects, sending out mail fine.

the second neccessary when 1 reservation has many validations. or when rest-clients need track validations separately reservations (e.g. get /reservations/{id}/validations/{id}). in cases makes sense have validation resource.
post /reservations/{id}/validations.
if reservation has no email-address, send along.
post /reservations/{id}/validations email=foo@example.com.
reads "make validation reservation on email foo@example.com". reads "i make new validation on reservation". since post (and patch) may have side-effects, sending out mail fine.

the third case important, because of side-effects. if want present way clients can there no side-effects, comes play.
put /reservations/{id} room=12&date=1970-01-01&status=valid&email=foo@example.com
reads "replace exsiting reservation validation has validated status." since put should never have side-effects, client can replaying (on e.g. network errors, heavy load or whatever) never cause user spammed.


Comments

Post a Comment

Popular posts from this blog

android - Get AccessToken using signpost OAuth without opening a browser (Two legged Oauth) -

i using signpost oauth access data magento server. have read various tutorials on same , reach point open browser user can enter credentials. however, per requirement have automate part. hence, user should not browser page. have set-up done on server side ( magento ), hit url , returned call page. same through program in android. i have tried below, consumer = new commonshttpoauthconsumer(key, secret); provider = new commonshttpoauthprovider(oauth_init_url,access_token_url, authorize_url); try { provider.retrieverequesttoken(consumer, oauth.out_of_band); log.d("tokens" , consumer.gettoken() + " -- " + consumer.gettokensecret()); } and request tokens. dont know how bypass next step. tried directly accessing accesstoken (stupid of me) provider.retrieveaccesstoken(consumer, "mycallback://callback"); no luck, ends in oauth.signpost.exception.oauthnotauthorizedexception: authorization failed (server replied 401). ...
Read more

org.mockito.exceptions.misusing.InvalidUseOfMatchersException: mockito -

getting error org.mockito.exceptions.misusing.invaliduseofmatchersexception: invalid use of argument matchers! 1 matchers expected, 2 recorded. exception may occur if matchers combined raw values: //incorrect: somemethod(anyobject(), "raw string"); when using matchers, arguments have provided matchers. example: //correct: somemethod(anyobject(), eq("string matcher")); at when( getprogramservice .callservice(any(getprogramtype.class))) .thenreturn(jaxbresponse); please explain error , possible resolution the code posted looks fine; don't see problem it. code before or above causing exception. key here: invalid use of argument matchers! 1 matchers expected, 2 recorded. any , used above, doesn't return "special kind of null" or "special kind of getprogramtype"; don't exist. instead, returns null , side effect puts matcher on stack. whe...
Read more

google shop client API returns 400 bad request error while adding an item -

i'm working on solution add items in google shopping market java application. following tutorial real mess because of missing classes of laste release, after setting 1.5-beta maven managed make base example typecheck correctly classes. still can make simple task of adding 1 item. instead of posting whole code i'm posting part creates product feed. private product createproduct(string id) { product product = new product(); product.title = "red wool sweater"; product.content = new content( "text", "comfortable , soft, sweater keep warm on " + "cold winter nights. red , blue stripes."); product.appcontrol = new appcontrol(); product.appcontrol.addrequireddestination("productads"); product.externalid = id; product.lang = "it"; product.country = "it"; product.condition = "nuovo"; product.price = new price("eu...
Read more