Responses are represented as instances of the case class
T is the type of the response body. When sending a request, an effect containing the response will be returned. For example, for asynchronous backends, we can get a
Future[Response[T]], while for the default synchronous backend, the wrapper will be a no-op,
Identity, which is the same as no wrapper at all.
If sending the request fails, either due to client or connection errors, an exception will be thrown (synchronous backends), or a failed effect will be returned (e.g. a failed future).
If the request completes, but results in a non-2xx return code, the request is still considered successful, that is, a
Response[T] will be returned. See response body specifications for details on how such cases are handled.
The response code is available through the
.code property. There are also methods such as
.isServerError for checking specific response code ranges.
Response headers are available through the
.headers property, which gives all headers as a sequence (not as a map, as there can be multiple headers with the same name).
Individual headers can be obtained using the methods:
import sttp.model._ import sttp.client3._ val backend = HttpURLConnectionBackend() val request = basicRequest .get(uri"http://endpoint.com/example") val response = request.send(backend) val singleHeader: Option[String] = response.header(HeaderNames.Server) val multipleHeaders: Seq[String] = response.headers(HeaderNames.Allow)
There are also helper methods available to read some commonly accessed headers:
val contentType: Option[String] = response.contentType val contentLength: Option[Long] = response.contentLength
Finally, it’s possible to parse the response cookies into a sequence of the
CookieWithMeta case class:
import sttp.model.headers.CookieWithMeta val cookies: Seq[CookieWithMeta] = response.unsafeCookies
If the cookies from a response should be set without changes on the request, this can be done directly; see the cookies section in the request definition documentation.
Obtaining the response body¶
The response body can be obtained through the
.body: T property.
T is the body deserialized as specified in the request description - see
the next section on response body specifications.