My users enter a few information fields in a iOS app. This information must be validated on my server, which has a RESTful API. After validation the UI of the iOS app changes to indicate the result.
Neither GET, PUT, or POST seem to be appropriate, because I'm not getting a resource, and neither is a resource created or updated.
What is the best fitting REST operation to implement this validation?
I use the same scenario as you and use PUT for it. You have to ask yourself: "when I send the same request twice, does this make a different state on server?" If yes, use POST, if no use PUT.
I recommend using a
ValidationResource
and two requests. Each instance of this resource represents the validation of a set of data. The workflow:1. Create new
ValidationResource
POST /path/to/validations
201 Created
Location: /path/to/validations/<unique-id-of-this-validation>
2. Look up result
GET /path/to/validations/<unique-id-of-this-validation>
200 OK
{'valid': true}
or{'valid': false}
This is a RESTful approach in which the Validation is a Resource with server state.
Since you aren't saving anything (not modifying any resource), I'd think this is technically more RPC than RESTful to me.
The following is my opinion, so don't take it as gospel:
If the information is simply being submitted and you're saying yes or no, and you're not saving it, I'd say
POST
is fine..If information were actually being saved / updated, then choosing the proper HTTP method would be a lot more relevant.