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

> Chilkat 11.7.0 · language=js · 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/js/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**

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkHttpResponse();
```

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 JavaScript.

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` | 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` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BodyQP` | property, read-only | `BodyQP` |
| `BodyStr` | property, read-only | `BodyStr` |
| `Charset` | property, read-only | `Charset` |
| `ContentLength` | property, read-only | `ContentLength` |
| `DateStr` | property, read-only | `DateStr` |
| `Domain` | property, read-only | `Domain` |
| `FinalRedirectUrl` | property, read-only | `FinalRedirectUrl` |
| `FullMime` | property, read-only | `FullMime` |
| `Header` | property, read-only | `Header` |
| `NumCookies` | property, read-only | `NumCookies` |
| `NumHeaderFields` | property, read-only | `NumHeaderFields` |
| `StatusCode` | property, read-only | `StatusCode` |
| `StatusLine` | property, read-only | `StatusLine` |
| `StatusText` | property, read-only | `StatusText` |
| `UncommonOptions` | property, read/write | `UncommonOptions` |
| `GetBodyBd` | method | `var success = GetBodyBd(binData);` |
| `GetBodyJarr` | method | `var success = GetBodyJarr(jarr);` |
| `GetBodyJson` | method | `var success = GetBodyJson(json);` |
| `GetBodySb` | method | `var success = GetBodySb(sb);` |
| `GetBodyXml` | method | `var success = GetBodyXml(xml);` |
| `GetCookieDomain` | method | `var strVal = GetCookieDomain(index);` |
| `GetCookieExpiresStr` | method | `var strVal = GetCookieExpiresStr(index);` |
| `GetCookieName` | method | `var strVal = GetCookieName(index);` |
| `GetCookiePath` | method | `var strVal = GetCookiePath(index);` |
| `GetCookieValue` | method | `var strVal = GetCookieValue(index);` |
| `GetHeaderField` | method | `var strVal = GetHeaderField(fieldName);` |
| `GetHeaderFieldAttr` | method | `var strVal = GetHeaderFieldAttr(fieldName, attrName);` |
| `GetHeaderName` | method | `var strVal = GetHeaderName(index);` |
| `GetHeaderValue` | method | `var strVal = GetHeaderValue(index);` |
| `SaveBodyBinary` | method | `var success = SaveBodyBinary(path);` |
| `SaveBodyText` | method | `var success = SaveBodyText(bCrlf, path);` |
| `UrlEncParamValue` | method | `var strVal = UrlEncParamValue(encodedParamString, paramName);` |

## Properties

### HttpResponse.BodyQP

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

```javascript
BodyQP
```

· `string`, `read-only`

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

### HttpResponse.BodyStr

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

```javascript
BodyStr
```

· `string`, `read-only`

The response body returned as a string.

### HttpResponse.Charset

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

```javascript
Charset
```

· `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 · js · HttpResponse · ContentLength · property · read-only`

```javascript
ContentLength
```

· `unsigned int`, `read-only`

The content length of the response, in bytes.

### HttpResponse.DateStr

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

```javascript
DateStr
```

· `string`, `read-only`

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

### HttpResponse.Domain

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

```javascript
Domain
```

· `string`, `read-only`

The domain of the HTTP server that created this response.

### HttpResponse.FinalRedirectUrl

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

```javascript
FinalRedirectUrl
```

· `string`, `read-only`

Returns the redirect URL for 301/302 responses.

### HttpResponse.FullMime

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

```javascript
FullMime
```

· `string`, `read-only`

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

### HttpResponse.Header

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

```javascript
Header
```

· `string`, `read-only`

The full text of the response header.

### HttpResponse.NumCookies

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

```javascript
NumCookies
```

· `int`, `read-only`

The number of cookies included in the response.

### HttpResponse.NumHeaderFields

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

```javascript
NumHeaderFields
```

· `int`, `read-only`

The number of response header fields.

### HttpResponse.StatusCode

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

```javascript
StatusCode
```

· `int`, `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 · js · HttpResponse · StatusLine · property · read-only`

```javascript
StatusLine
```

· `string`, `read-only`

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

### HttpResponse.StatusText

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

```javascript
StatusText
```

· `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 · js · HttpResponse · UncommonOptions · property · read/write · since 9.5.0.89`

```javascript
UncommonOptions
```

· `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 · js · HttpResponse · GetBodyBd · method · since 9.5.0.64`

```javascript
var success = GetBodyBd(binData);
```

· return: `boolean`; `true` for success, `false` for failure  
· binData: `CkBinData`

Copies the response body to a BinData object.

Returns true for success, false for failure.

### HttpResponse.GetBodyJarr

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

```javascript
var success = GetBodyJarr(jarr);
```

· return: `boolean`; `true` for success, `false` for failure  
· jarr: `CkJsonArray`

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 · js · HttpResponse · GetBodyJson · method · since 9.5.0.89`

```javascript
var success = GetBodyJson(json);
```

· return: `boolean`; `true` for success, `false` for failure  
· json: `CkJsonObject`

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 · js · HttpResponse · GetBodySb · method · since 9.5.0.64`

```javascript
var success = GetBodySb(sb);
```

· return: `boolean`; `true` for success, `false` for failure  
· sb: `CkStringBuilder`

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

### HttpResponse.GetBodyXml

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

```javascript
var success = GetBodyXml(xml);
```

· return: `boolean`; `true` for success, `false` for failure  
· xml: `CkXml`

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 · js · HttpResponse · GetCookieDomain · method`

```javascript
var strVal = GetCookieDomain(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.GetCookieExpiresStr

`Chilkat 11.7.0 · js · HttpResponse · GetCookieExpiresStr · method`

```javascript
var strVal = GetCookieExpiresStr(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.GetCookieName

`Chilkat 11.7.0 · js · HttpResponse · GetCookieName · method`

```javascript
var strVal = GetCookieName(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.GetCookiePath

`Chilkat 11.7.0 · js · HttpResponse · GetCookiePath · method`

```javascript
var strVal = GetCookiePath(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.GetCookieValue

`Chilkat 11.7.0 · js · HttpResponse · GetCookieValue · method`

```javascript
var strVal = GetCookieValue(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.GetHeaderField

`Chilkat 11.7.0 · js · HttpResponse · GetHeaderField · method`

```javascript
var strVal = GetHeaderField(fieldName);
```

· return: `string`  
· fieldName: `string`

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

Returns `null` on failure

### HttpResponse.GetHeaderFieldAttr

`Chilkat 11.7.0 · js · HttpResponse · GetHeaderFieldAttr · method`

```javascript
var strVal = GetHeaderFieldAttr(fieldName, attrName);
```

· return: `string`  
· fieldName: `string`  
· attrName: `string`

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

Returns `null` on failure

### HttpResponse.GetHeaderName

`Chilkat 11.7.0 · js · HttpResponse · GetHeaderName · method`

```javascript
var strVal = GetHeaderName(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.GetHeaderValue

`Chilkat 11.7.0 · js · HttpResponse · GetHeaderValue · method`

```javascript
var strVal = GetHeaderValue(index);
```

· return: `string`  
· index: `int`

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 `null` on failure

### HttpResponse.SaveBodyBinary

`Chilkat 11.7.0 · js · HttpResponse · SaveBodyBinary · method`

```javascript
var success = SaveBodyBinary(path);
```

· return: `boolean`; `true` for success, `false` for failure  
· path: `string`

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

### HttpResponse.SaveBodyText

`Chilkat 11.7.0 · js · HttpResponse · SaveBodyText · method`

```javascript
var success = SaveBodyText(bCrlf, path);
```

· return: `boolean`; `true` for success, `false` for failure  
· bCrlf: `boolean`  
· path: `string`

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 · js · HttpResponse · UrlEncParamValue · method`

```javascript
var strVal = UrlEncParamValue(encodedParamString, paramName);
```

· return: `string`  
· encodedParamString: `string`  
· paramName: `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 `null` on failure

## Related classes

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