Passing array in GET for a REST call

rest restful-url restful-architecture
ChrisOdney picture ChrisOdney · Aug 14, 2012 · Viewed 134.4k times · Source

I have a url to fetch appointments for a user like this:

/user/:userId/appointments

How should the url look like if I want to get appointments for multiple users?

should it be:

/appointments?users=1d1,1d2..

Thanks, Chris.

Answer

bryanmac picture bryanmac · Aug 14, 2012

Collections are a resource so /appointments is fine as the resource.

Collections also typically offer filters via the querystring which is essentially what users=id1,id2... is.

So, 

/appointments?users=id1,id2

is fine as a filtered RESTful resource.

Related questions

When do I use path params vs. query params in a RESTful API?

I want to make my RESTful API very predictable. What is the best practice for deciding when to make a segmentation of data using the URI rather than by using query params. It makes sense to me that system parameters …

Read More
How to handle huge data from a REST service

We are using a REST service that returns huge data. In production, the server hardware can handle it. I need to test the REST service by getting the data on my local machine, which cannot handle the huge data. My …

Read More
Validate/Change Password via REST API

I want to change a user password via a REST API. This is not a forgotten or reset password function, but a logged in user wanting to change their password. The form requires the current password, the new password, and …

Read More