---
product: Chilkat
product_version: 11.7.0
language: xojo
language_label: Xojo
class: HttpResponse
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xojoHttpResponseRef.html
---
# Chilkat HttpResponse — Xojo — v11.7.0

> Chilkat 11.7.0 · language=xojo · class=HttpResponse
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/HttpResponse.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/guide.md`.

## Purpose

**Inspect HTTP status, headers, cookies, redirects, and response bodies.**

`Chilkat.HttpResponse` represents an HTTP response returned by certain `Chilkat.Http` methods. It provides access to the response status line, status code, headers, cookies, charset, content length, body bytes, body text, full MIME response, redirect URL, and helper methods for saving or loading the response body into Chilkat objects such as `BinData`, `StringBuilder`, `JsonObject`, `JsonArray`, and `Xml`.

**Status and reason**

Read the HTTP status code, status line, and related response information to determine whether the request succeeded, redirected, or failed.

**Headers and cookies**

Inspect response headers, retrieve individual header values, and access cookies returned by the server.

**Body as text or bytes**

Get the response body as raw bytes or decoded text, using the response charset information when appropriate.

**Structured body loading**

Load the body directly into `JsonObject`, `JsonArray`, `Xml`, `BinData`, or `StringBuilder` objects for further processing.

**Redirect information**

Access redirect-related information such as the redirect URL when the server responds with a redirect status.

**Save and inspect responses**

Save body content, inspect the full MIME-style response, and use response metadata for diagnostics, logging, or API troubleshooting.

**Common pattern:** Send a request with `Chilkat.Http`, check the `StatusCode`, inspect headers or cookies as needed, then retrieve the body in the form best suited to the response content: text, bytes, `BinData`, `StringBuilder`, JSON, or XML. Use `HttpResponse` for response inspection; use `Chilkat.Http` for the actual network request.

For an extended overview, see [HttpResponse Class Overview](https://www.chilkatsoft.com/httpresponse_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```xojo
Dim httpResponse As New Chilkat.HttpResponse
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Xojo.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BodyQP` | property, read-only | `BodyQP As String (read-only)` |
| `BodyStr` | property, read-only | `BodyStr As String (read-only)` |
| `Charset` | property, read-only | `Charset As String (read-only)` |
| `ContentLength` | property, read-only | `ContentLength As UInt32 (read-only)` |
| `DateStr` | property, read-only | `DateStr As String (read-only)` |
| `Domain` | property, read-only | `Domain As String (read-only)` |
| `FinalRedirectUrl` | property, read-only | `FinalRedirectUrl As String (read-only)` |
| `FullMime` | property, read-only | `FullMime As String (read-only)` |
| `Header` | property, read-only | `Header As String (read-only)` |
| `NumCookies` | property, read-only | `NumCookies As Int32 (read-only)` |
| `NumHeaderFields` | property, read-only | `NumHeaderFields As Int32 (read-only)` |
| `StatusCode` | property, read-only | `StatusCode As Int32 (read-only)` |
| `StatusLine` | property, read-only | `StatusLine As String (read-only)` |
| `StatusText` | property, read-only | `StatusText As String (read-only)` |
| `UncommonOptions` | property, read/write | `UncommonOptions As String` |
| `GetBodyBd` | method | `Function GetBodyBd(binData As Chilkat.BinData) As Boolean` |
| `GetBodyJarr` | method | `Function GetBodyJarr(jarr As Chilkat.JsonArray) As Boolean` |
| `GetBodyJson` | method | `Function GetBodyJson(json As Chilkat.JsonObject) As Boolean` |
| `GetBodySb` | method | `Function GetBodySb(sb As Chilkat.StringBuilder) As Boolean` |
| `GetBodyXml` | method | `Function GetBodyXml(xml As Chilkat.Xml) As Boolean` |
| `GetCookieDomain` | method | `Function GetCookieDomain(index As Int32) As String` |
| `GetCookieExpiresStr` | method | `Function GetCookieExpiresStr(index As Int32) As String` |
| `GetCookieName` | method | `Function GetCookieName(index As Int32) As String` |
| `GetCookiePath` | method | `Function GetCookiePath(index As Int32) As String` |
| `GetCookieValue` | method | `Function GetCookieValue(index As Int32) As String` |
| `GetHeaderField` | method | `Function GetHeaderField(fieldName As String) As String` |
| `GetHeaderFieldAttr` | method | `Function GetHeaderFieldAttr(fieldName As String, attrName As String) As String` |
| `GetHeaderName` | method | `Function GetHeaderName(index As Int32) As String` |
| `GetHeaderValue` | method | `Function GetHeaderValue(index As Int32) As String` |
| `LoadTaskResult` | method | `Function LoadTaskResult(task As Chilkat.Task) As Boolean` |
| `SaveBodyBinary` | method | `Function SaveBodyBinary(path As String) As Boolean` |
| `SaveBodyText` | method | `Function SaveBodyText(bCrlf As Boolean, path As String) As Boolean` |
| `UrlEncParamValue` | method | `Function UrlEncParamValue(encodedParamString As String, paramName As String) As String` |

## Properties

### HttpResponse.BodyQP

`Chilkat 11.7.0 · xojo · HttpResponse · BodyQP · property · read-only`

```xojo
BodyQP As String (read-only)
```

The same as the Body property, but returned as a quoted-printable encoded string.

### HttpResponse.BodyStr

`Chilkat 11.7.0 · xojo · HttpResponse · BodyStr · property · read-only`

```xojo
BodyStr As String (read-only)
```

The response body returned as a string.

### HttpResponse.Charset

`Chilkat 11.7.0 · xojo · HttpResponse · Charset · property · read-only`

```xojo
Charset As String (read-only)
```

The response charset, such as `iso-8859-1`, if applicable. Obviously, responses for GIF and JPG files will not have a charset.

### HttpResponse.ContentLength

`Chilkat 11.7.0 · xojo · HttpResponse · ContentLength · property · read-only`

```xojo
ContentLength As UInt32 (read-only)
```

The content length of the response, in bytes.

### HttpResponse.DateStr

`Chilkat 11.7.0 · xojo · HttpResponse · DateStr · property · read-only`

```xojo
DateStr As String (read-only)
```

Returns the content of the Date response header field in RFC822 date/time string format.

### HttpResponse.Domain

`Chilkat 11.7.0 · xojo · HttpResponse · Domain · property · read-only`

```xojo
Domain As String (read-only)
```

The domain of the HTTP server that created this response.

### HttpResponse.FinalRedirectUrl

`Chilkat 11.7.0 · xojo · HttpResponse · FinalRedirectUrl · property · read-only · since 9.5.0.49`

```xojo
FinalRedirectUrl As String (read-only)
```

Returns the redirect URL for 301/302 responses.

### HttpResponse.FullMime

`Chilkat 11.7.0 · xojo · HttpResponse · FullMime · property · read-only`

```xojo
FullMime As String (read-only)
```

Returns the full MIME (header + body) of the HTTP response.

### HttpResponse.Header

`Chilkat 11.7.0 · xojo · HttpResponse · Header · property · read-only`

```xojo
Header As String (read-only)
```

The full text of the response header.

### HttpResponse.NumCookies

`Chilkat 11.7.0 · xojo · HttpResponse · NumCookies · property · read-only`

```xojo
NumCookies As Int32 (read-only)
```

The number of cookies included in the response.

### HttpResponse.NumHeaderFields

`Chilkat 11.7.0 · xojo · HttpResponse · NumHeaderFields · property · read-only`

```xojo
NumHeaderFields As Int32 (read-only)
```

The number of response header fields.

### HttpResponse.StatusCode

`Chilkat 11.7.0 · xojo · HttpResponse · StatusCode · property · read-only`

```xojo
StatusCode As Int32 (read-only)
```

The status code (as an integer) from the first line of an HTTP response. If the StatusLine = `HTTP/1.0 200 OK`, the response status code returned is 200.

### HttpResponse.StatusLine

`Chilkat 11.7.0 · xojo · HttpResponse · StatusLine · property · read-only`

```xojo
StatusLine As String (read-only)
```

The first line of an HTTP response, such as `HTTP/1.0 200 OK`.

### HttpResponse.StatusText

`Chilkat 11.7.0 · xojo · HttpResponse · StatusText · property · read-only · since 9.5.0.49`

```xojo
StatusText As String (read-only)
```

The text that follows the status code in the 1st line of the HTTP response. For example, i the first line of an HTTP response is `HTTP/1.0 200 OK`, then this property contains `OK`.

### HttpResponse.UncommonOptions

`Chilkat 11.7.0 · xojo · HttpResponse · UncommonOptions · property · read/write · since 9.5.0.89`

```xojo
UncommonOptions As String
```

This is a catch-all property to be used for uncommon needs. Can be set to a list of the following comma separated keywords:

- `TakeResponseBody` - Introduced in v9.5.0.89. The GetBody\* methods will transfer the body to the target object instead of copying the contents. This can be useful if the response body is extremely large because it will reduce the overall memory requirement.

## Methods

### HttpResponse.GetBodyBd

`Chilkat 11.7.0 · xojo · HttpResponse · GetBodyBd · method · since 9.5.0.64`

```xojo
Function GetBodyBd(binData As Chilkat.BinData) As Boolean
```

Copies the response body to a BinData object.

Returns True for success, False for failure.

### HttpResponse.GetBodyJarr

`Chilkat 11.7.0 · xojo · HttpResponse · GetBodyJarr · method · since 9.5.0.89`

```xojo
Function GetBodyJarr(jarr As Chilkat.JsonArray) As Boolean
```

Loads the JSON array response body into a JsonArray This method should only be called when it is known that the response body contains a JSON array (beginning with a square bracket '\[' and ending with a square bracket '\]')

Returns True for success, False for failure.

### HttpResponse.GetBodyJson

`Chilkat 11.7.0 · xojo · HttpResponse · GetBodyJson · method · since 9.5.0.89`

```xojo
Function GetBodyJson(json As Chilkat.JsonObject) As Boolean
```

Loads the JSON response body into a JsonObject. This method should only be called when it is known that the response body contains JSON (beginning with a curly brace '{' and ending with a curly brace '}')

Returns True for success, False for failure.

### HttpResponse.GetBodySb

`Chilkat 11.7.0 · xojo · HttpResponse · GetBodySb · method · since 9.5.0.64`

```xojo
Function GetBodySb(sb As Chilkat.StringBuilder) As Boolean
```

Copies the response body to a Chilkat StringBuilder object.

Returns True for success, False for failure.

### HttpResponse.GetBodyXml

`Chilkat 11.7.0 · xojo · HttpResponse · GetBodyXml · method · since 9.5.0.89`

```xojo
Function GetBodyXml(xml As Chilkat.Xml) As Boolean
```

Loads the XML response body into an XML object. This method should only be called when it is known that the response body contains XML.

Returns True for success, False for failure.

### HttpResponse.GetCookieDomain

`Chilkat 11.7.0 · xojo · HttpResponse · GetCookieDomain · method`

```xojo
Function GetCookieDomain(index As Int32) As String
```

Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns `Nil` on failure

### HttpResponse.GetCookieExpiresStr

`Chilkat 11.7.0 · xojo · HttpResponse · GetCookieExpiresStr · method`

```xojo
Function GetCookieExpiresStr(index As Int32) As String
```

Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns `Nil` on failure

### HttpResponse.GetCookieName

`Chilkat 11.7.0 · xojo · HttpResponse · GetCookieName · method`

```xojo
Function GetCookieName(index As Int32) As String
```

Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns `Nil` on failure

### HttpResponse.GetCookiePath

`Chilkat 11.7.0 · xojo · HttpResponse · GetCookiePath · method`

```xojo
Function GetCookiePath(index As Int32) As String
```

Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns `Nil` on failure

### HttpResponse.GetCookieValue

`Chilkat 11.7.0 · xojo · HttpResponse · GetCookieValue · method`

```xojo
Function GetCookieValue(index As Int32) As String
```

Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns `Nil` on failure

### HttpResponse.GetHeaderField

`Chilkat 11.7.0 · xojo · HttpResponse · GetHeaderField · method`

```xojo
Function GetHeaderField(fieldName As String) As String
```

Returns the value of a response header field accessed by field name.

Returns `Nil` on failure

### HttpResponse.GetHeaderFieldAttr

`Chilkat 11.7.0 · xojo · HttpResponse · GetHeaderFieldAttr · method`

```xojo
Function GetHeaderFieldAttr(fieldName As String, attrName As String) As String
```

Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr(`content-type`,`charset`)

Returns `Nil` on failure

### HttpResponse.GetHeaderName

`Chilkat 11.7.0 · xojo · HttpResponse · GetHeaderName · method`

```xojo
Function GetHeaderName(index As Int32) As String
```

Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns `Nil` on failure

### HttpResponse.GetHeaderValue

`Chilkat 11.7.0 · xojo · HttpResponse · GetHeaderValue · method`

```xojo
Function GetHeaderValue(index As Int32) As String
```

Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns `Nil` on failure

### HttpResponse.LoadTaskResult

`Chilkat 11.7.0 · xojo · HttpResponse · LoadTaskResult · method · since 9.5.0.52`

```xojo
Function LoadTaskResult(task As Chilkat.Task) As Boolean
```

Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).

Returns True for success, False for failure.

### HttpResponse.SaveBodyBinary

`Chilkat 11.7.0 · xojo · HttpResponse · SaveBodyBinary · method`

```xojo
Function SaveBodyBinary(path As String) As Boolean
```

Saves the body of the HTTP response to a file.

Returns True for success, False for failure.

### HttpResponse.SaveBodyText

`Chilkat 11.7.0 · xojo · HttpResponse · SaveBodyText · method`

```xojo
Function SaveBodyText(bCrlf As Boolean, path As String) As Boolean
```

Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If `bCrlf` is `True`, then line endings are automatically converted to CRLF if necessary. If `bCrlf` is `False`, then line-endings are automatically converted to bare-LF's (Unix style) if necessary.

To save the HTTP response body exactly as-is (with no line-ending manipulation), then call SaveBodyBinary.

Returns True for success, False for failure.

### HttpResponse.UrlEncParamValue

`Chilkat 11.7.0 · xojo · HttpResponse · UrlEncParamValue · method`

```xojo
Function UrlEncParamValue(encodedParamString As String, paramName As String) As String
```

Convenience method for parsing a param's value out of a URL-encoded param string. For example, if a caller passes the following string in `encodedParamString`:

```
oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=true
```

and `oauth_token_secret` in `paramName`, then the return value would be `123`.

Returns `Nil` on failure

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/BinData.md), [`JsonArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/JsonArray.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/Task.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xojo/classes/Xml.md)