How to handle optional query parameters in Play framework

scala playframework playframework-2.0
magicduncan picture magicduncan · Mar 11, 2012 · Viewed 53.1k times · Source

Lets say I have an already functioning Play 2.0 framework based application in Scala that serves a URL such as:

http://localhost:9000/birthdays

which responds with a listing of all known birthdays

I now want to enhance this by adding the ability to restrict results with optional "from" (date) and "to" request params such as

http://localhost:9000/birthdays?from=20120131&to=20120229

(dates here interpreted as yyyyMMdd)

My question is how to handle the request param binding and interpretation in Play 2.0 with Scala, especially given that both of these params should be optional.

Should these parameters be somehow expressed in the "routes" specification? Alternatively, should the responding Controller method pick apart the params from the request object somehow? Is there another way to do this?

Answer

Julien Richard-Foy picture Julien Richard-Foy · Mar 11, 2012

Encode your optional parameters as Option[String] (or Option[java.util.Date], but you’ll have to implement your own QueryStringBindable[Date]):

def birthdays(from: Option[String], to: Option[String]) = Action {
  // …
}

And declare the following route:

GET   /birthday       controllers.Application.birthday(from: Option[String], to: Option[String])

Related questions

Scala/Play: parse JSON into Map instead of JsObject

On Play Framework's homepage they claim that "JSON is a first class citizen". I have yet to see the proof of that. In my project I'm dealing with some pretty complex JSON structures. This is just a very simple example: { "…

Read More
Declare variable in a Play2 scala template

How do you declare and initialize a variable to be used locally in a Play2 Scala template? I have this: @var title : String = "Home" declared at the top of the template, but it gives me this error: illegal start of …

Read More
How to convert Scala Map into JSON String?

For example, I have this Map value in Scala: val m = Map( "name" -> "john doe", "age" -> 18, "hasChild" -> true, "childs" -> List( Map("name" -> "dorothy", "age" -> 5, "hasChild" -> false), …

Read More