--- product: Chilkat product_version: 11.7.0 language: ckpython language_label: CkPython class: HttpRequest class_name: CkHttpRequest license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/pythonCkHttpRequestRef.html --- # Chilkat HttpRequest — CkPython — v11.7.0 > Chilkat 11.7.0 · language=ckpython · class=HttpRequest (CkHttpRequest) > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/HttpRequest.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckpython/guide.md`. ## Purpose **Build structured HTTP requests for use with Chilkat.Http.** `Chilkat.HttpRequest` is a helper class for constructing HTTP requests that are sent by `Chilkat.Http`. It does not perform network communication on its own. Instead, it provides structured control over the request method, HTTP version, path, headers, query parameters, form parameters, content type, request body, multipart uploads, streamed file bodies, and diagnostic request generation. **Request construction** Build an HTTP request object with the method, path, version, headers, parameters, and body settings required by the target endpoint. **Form parameters** Add name/value parameters for form posts and API requests that expect structured form data. **Custom headers** Set request headers such as content type, accept headers, authorization headers, or application-specific metadata. **Request bodies** Provide body content for POST, PUT, PATCH, or other methods that send data to a server. **Multipart and file uploads** Construct multipart/form-data requests, attach file parts, or stream a file as the request body when the API requires upload content. **Diagnostics** Generate a textual representation of the request to inspect headers, paths, parameters, body structure, and upload formatting before sending. **Common pattern:** Create a `HttpRequest`, set the HTTP method and path, add any headers, parameters, body data, or file parts, then pass the request object to the appropriate `Chilkat.Http` method for sending. Use `HttpRequest` for structured or multipart requests; use simpler `Http` methods directly when only a basic GET, POST, upload, or download is needed. For an extended overview, see [HttpRequest Class Overview](https://www.chilkatsoft.com/httprequest_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```python obj = chilkat.CkHttpRequest() ``` 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 CkPython. 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` | `# strVal is a string # ckStr is a CkString httpRequest.get_DebugLogFilePath(ckStr); strVal = httpRequest.debugLogFilePath(); httpRequest.put_DebugLogFilePath(strVal);` | 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` | `# strVal is a string # ckStr is a CkString httpRequest.get_LastErrorHtml(ckStr); strVal = httpRequest.lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `# strVal is a string # ckStr is a CkString httpRequest.get_LastErrorText(ckStr); strVal = httpRequest.lastErrorText();` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `# strVal is a string # ckStr is a CkString httpRequest.get_LastErrorXml(ckStr); strVal = httpRequest.lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `# boolVal is a boolean boolVal = httpRequest.get_LastMethodSuccess(); httpRequest.put_LastMethodSuccess(boolVal);` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `Utf8` | `# boolVal is a boolean boolVal = httpRequest.get_Utf8(); httpRequest.put_Utf8(boolVal);` | read/write | When set to `True`, all `string` arguments and return values are interpreted as UTF-8 strings. | | `VerboseLogging` | `# boolVal is a boolean boolVal = httpRequest.get_VerboseLogging(); httpRequest.put_VerboseLogging(boolVal);` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `# strVal is a string # ckStr is a CkString httpRequest.get_Version(ckStr); strVal = httpRequest.version();` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `Boundary` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_Boundary(ckStr); strVal = httpRequest.boundary(); httpRequest.put_Boundary(strVal);` | | `Charset` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_Charset(ckStr); strVal = httpRequest.charset(); httpRequest.put_Charset(strVal);` | | `ContentType` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_ContentType(ckStr); strVal = httpRequest.contentType(); httpRequest.put_ContentType(strVal);` | | `EntireHeader` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_EntireHeader(ckStr); strVal = httpRequest.entireHeader(); httpRequest.put_EntireHeader(strVal);` | | `HttpVerb` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_HttpVerb(ckStr); strVal = httpRequest.httpVerb(); httpRequest.put_HttpVerb(strVal);` | | `HttpVersion` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_HttpVersion(ckStr); strVal = httpRequest.httpVersion(); httpRequest.put_HttpVersion(strVal);` | | `NumHeaderFields` | property, read-only | `# intVal is an integer intVal = httpRequest.get_NumHeaderFields();` | | `NumParams` | property, read-only | `# intVal is an integer intVal = httpRequest.get_NumParams();` | | `Path` | property, read/write | `# strVal is a string # ckStr is a CkString httpRequest.get_Path(ckStr); strVal = httpRequest.path(); httpRequest.put_Path(strVal);` | | `SendCharset` | property, read/write | `# boolVal is a boolean boolVal = httpRequest.get_SendCharset(); httpRequest.put_SendCharset(boolVal);` | | `AddBdForUpload` | method | `# name is a string # remoteFilename is a string # byteData is a CkBinData # contentType is a string status = httpRequest.AddBdForUpload(name, remoteFilename, byteData, contentType);` | | `AddFileForUpload` | method | `# name is a string # filePath is a string status = httpRequest.AddFileForUpload(name, filePath);` | | `AddFileForUpload2` | method | `# name is a string # filePath is a string # contentType is a string status = httpRequest.AddFileForUpload2(name, filePath, contentType);` | | `AddHeader` | method | `# name is a string # value is a string httpRequest.AddHeader(name, value);` | | `AddMwsSignature` | method | `# domain is a string # mwsSecretKey is a string status = httpRequest.AddMwsSignature(domain, mwsSecretKey);` | | `AddParam` | method | `# name is a string # value is a string httpRequest.AddParam(name, value);` | | `AddStringForUpload` | method | `# name is a string # filename is a string # strData is a string # charset is a string status = httpRequest.AddStringForUpload(name, filename, strData, charset);` | | `AddStringForUpload2` | method | `# name is a string # filename is a string # strData is a string # charset is a string # contentType is a string status = httpRequest.AddStringForUpload2(name, filename, strData, charset, contentType);` | | `AddSubHeader` | method | `# index is an integer # name is a string # value is a string status = httpRequest.AddSubHeader(index, name, value);` | | `GenerateRequestFile` | method | `# path is a string status = httpRequest.GenerateRequestFile(path);` | | `GenerateRequestText` | method | `# outStr is a CkString (output) status = httpRequest.GenerateRequestText(outStr); retStr = httpRequest.generateRequestText();` | | `GetHeaderField` | method | `# name is a string # outStr is a CkString (output) status = httpRequest.GetHeaderField(name, outStr); retStr = httpRequest.getHeaderField(name);` | | `GetHeaderName` | method | `# index is an integer # outStr is a CkString (output) status = httpRequest.GetHeaderName(index, outStr); retStr = httpRequest.getHeaderName(index);` | | `GetHeaderValue` | method | `# index is an integer # outStr is a CkString (output) status = httpRequest.GetHeaderValue(index, outStr); retStr = httpRequest.getHeaderValue(index);` | | `GetParam` | method | `# name is a string # outStr is a CkString (output) status = httpRequest.GetParam(name, outStr); retStr = httpRequest.getParam(name);` | | `GetParamName` | method | `# index is an integer # outStr is a CkString (output) status = httpRequest.GetParamName(index, outStr); retStr = httpRequest.getParamName(index);` | | `GetParamValue` | method | `# index is an integer # outStr is a CkString (output) status = httpRequest.GetParamValue(index, outStr); retStr = httpRequest.getParamValue(index);` | | `GetUrlEncodedParams` | method | `# outStr is a CkString (output) status = httpRequest.GetUrlEncodedParams(outStr); retStr = httpRequest.getUrlEncodedParams();` | | `LoadBodyFromBd` | method | `# requestBody is a CkBinData status = httpRequest.LoadBodyFromBd(requestBody);` | | `LoadBodyFromFile` | method | `# filePath is a string status = httpRequest.LoadBodyFromFile(filePath);` | | `LoadBodyFromSb` | method | `# requestBody is a CkStringBuilder # charset is a string status = httpRequest.LoadBodyFromSb(requestBody, charset);` | | `LoadBodyFromString` | method | `# bodyStr is a string # charset is a string status = httpRequest.LoadBodyFromString(bodyStr, charset);` | | `RemoveAllParams` | method | `httpRequest.RemoveAllParams();` | | `RemoveHeader` | method | `# name is a string status = httpRequest.RemoveHeader(name);` | | `RemoveParam` | method | `# name is a string httpRequest.RemoveParam(name);` | | `SetFromUrl` | method | `# url is a string httpRequest.SetFromUrl(url);` | | `StreamBodyFromFile` | method | `# filePath is a string status = httpRequest.StreamBodyFromFile(filePath);` | | `StreamChunkFromFile` | method | `# path is a string # offset is a string # numBytes is a string status = httpRequest.StreamChunkFromFile(path, offset, numBytes);` | Deprecated members are listed at the end of this file with their replacements; do not use them in new code. ## Properties ### HttpRequest.Boundary `Chilkat 11.7.0 · ckpython · HttpRequest · Boundary · property · read/write · since 9.5.0.49` ```python # strVal is a string # ckStr is a CkString httpRequest.get_Boundary(ckStr); strVal = httpRequest.boundary(); httpRequest.put_Boundary(strVal); ``` Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request. ### HttpRequest.Charset `Chilkat 11.7.0 · ckpython · HttpRequest · Charset · property · read/write` ```python # strVal is a string # ckStr is a CkString httpRequest.get_Charset(ckStr); strVal = httpRequest.charset(); httpRequest.put_Charset(strVal); ``` **Full documentation for this property (same in every language):** [How Charset Matters with HTTP Query Parameters](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/how_charset_matters_with_http_query_params.md) Controls the character encoding used in the URL encoding of query params. The default value of this propoerty is `utf-8`. ### HttpRequest.ContentType `Chilkat 11.7.0 · ckpython · HttpRequest · ContentType · property · read/write` ```python # strVal is a string # ckStr is a CkString httpRequest.get_ContentType(ckStr); strVal = httpRequest.contentType(); httpRequest.put_ContentType(strVal); ``` The ContentType property sets the `Content-Type` header field, and identifies the content-type of the HTTP request body. Common values are: > ``` > application/x-www-form-urlencoded > multipart/form-data > application/json > application/xml > ``` If ContentType is set equal to the empty string, then no Content-Type header is included in the HTTP request. ### HttpRequest.EntireHeader `Chilkat 11.7.0 · ckpython · HttpRequest · EntireHeader · property · read/write` ```python # strVal is a string # ckStr is a CkString httpRequest.get_EntireHeader(ckStr); strVal = httpRequest.entireHeader(); httpRequest.put_EntireHeader(strVal); ``` Composes and returns the entire MIME header of the HTTP request. ### HttpRequest.HttpVerb `Chilkat 11.7.0 · ckpython · HttpRequest · HttpVerb · property · read/write` ```python # strVal is a string # ckStr is a CkString httpRequest.get_HttpVerb(ckStr); strVal = httpRequest.httpVerb(); httpRequest.put_HttpVerb(strVal); ``` The HttpVerb property should be set to the name of the HTTP method that appears on the `start line` of an HTTP request, such as GET, POST, PUT, DELETE, etc. It is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to anything, even custom verbs recognized by a custom server-side app. ### HttpRequest.HttpVersion `Chilkat 11.7.0 · ckpython · HttpRequest · HttpVersion · property · read/write` ```python # strVal is a string # ckStr is a CkString httpRequest.get_HttpVersion(ckStr); strVal = httpRequest.httpVersion(); httpRequest.put_HttpVersion(strVal); ``` The HTTP version in the request header. Defaults to `1.1`. Can only be set to `1.0` or `1.1`. ### HttpRequest.NumHeaderFields `Chilkat 11.7.0 · ckpython · HttpRequest · NumHeaderFields · property · read-only` ```python # intVal is an integer intVal = httpRequest.get_NumHeaderFields(); ``` Returns the number of request header fields. ### HttpRequest.NumParams `Chilkat 11.7.0 · ckpython · HttpRequest · NumParams · property · read-only` ```python # intVal is an integer intVal = httpRequest.get_NumParams(); ``` Returns the number of query parameters. ### HttpRequest.Path `Chilkat 11.7.0 · ckpython · HttpRequest · Path · property · read/write` ```python # strVal is a string # ckStr is a CkString httpRequest.get_Path(ckStr); strVal = httpRequest.path(); httpRequest.put_Path(strVal); ``` The path of the resource requested. A path of `/` indicates the default document of a domain. **Explaining the Parts of a URL** ``` http://example.com:8042/over/there?name=ferret#nose \__/ \______________/\_________/ \________/ \__/ | | | | | scheme domain+port path query fragment ``` **This property should be set to the path part of the URL.** You may also include the query part in this property value. If the Content-Type of the request is NOT application/x-www-form-urlencoded, then you would definitely want to include query parameters in the path. If the Content-Type of the request IS application/x-www-form-urlencoded, the query parameters are passed in the body of the request. It is also possible to pass some query parameters via the path, and some in the body of a application/x-www-form-urlencoded request, but you shouldn't include the same parameter in both places. You would never need to include the fragment part. The fragment is nothing more than an instruction for a browser to automatically navigate to a particular location in the HTML page (assuming the request returns HTML, otherwise a fragment makes no sense). ### HttpRequest.SendCharset `Chilkat 11.7.0 · ckpython · HttpRequest · SendCharset · property · read/write` ```python # boolVal is a boolean boolVal = httpRequest.get_SendCharset(); httpRequest.put_SendCharset(boolVal); ``` Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request. The default value of this property is `False`. ## Methods ### HttpRequest.AddBdForUpload `Chilkat 11.7.0 · ckpython · HttpRequest · AddBdForUpload · method · since 9.5.0.76` ```python # name is a string # remoteFilename is a string # byteData is a CkBinData # contentType is a string status = httpRequest.AddBdForUpload(name, remoteFilename, byteData, contentType); ``` Adds a file to an upload request where the contents of the file come from `byteData`. `name` is an arbitrary name. (In HTML, it is the form field name of the input tag.) `remoteFilename` is the name of the file to be created on the HTTP server. `byteData` contains the bytes to be uploaded. `contentType` contains is the value of the Content-Type header. An empty string may be passed to allow Chilkat to automatically determine the Content-Type based on the filename extension. Returns True for success, False for failure. ### HttpRequest.AddFileForUpload `Chilkat 11.7.0 · ckpython · HttpRequest · AddFileForUpload · method` ```python # name is a string # filePath is a string status = httpRequest.AddFileForUpload(name, filePath); ``` Adds a file to an upload request. To create a file upload request, set the ContentType property = `multipart/form-data` and then call AddFileForUpload, AddBytesForUpload, or AddStringForUpload for each file to be uploaded. This method does not read the file into memory. When the upload occurs, the data is streamed directly from the file, thus allowing for very large files to be uploaded without consuming large amounts of memory. `name` is an arbitrary name. (In HTML, it is the form field name of the input tag.) `filePath` is the path to an existing file in the local filesystem. Returns True for success, False for failure. ### HttpRequest.AddFileForUpload2 `Chilkat 11.7.0 · ckpython · HttpRequest · AddFileForUpload2 · method` ```python # name is a string # filePath is a string # contentType is a string status = httpRequest.AddFileForUpload2(name, filePath, contentType); ``` Same as AddFileForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the file extension.) `name` is an arbitrary name. (In HTML, it is the form field name of the input tag.) `filePath` is the path to an existing file in the local filesystem. Returns True for success, False for failure. ### HttpRequest.AddHeader `Chilkat 11.7.0 · ckpython · HttpRequest · AddHeader · method` ```python # name is a string # value is a string httpRequest.AddHeader(name, value); ``` Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it. **Note:** Never explicitly set the Content-Length header field. Chilkat will automatically compute the correct length and add the Content-Length header to all POST, PUT, or any other request where the Content-Length needs to be specified. (GET requests always have a 0 length body, and therefore never need a Content-Length header field.) ### HttpRequest.AddMwsSignature `Chilkat 11.7.0 · ckpython · HttpRequest · AddMwsSignature · method · since 9.5.0.66` ```python # domain is a string # mwsSecretKey is a string status = httpRequest.AddMwsSignature(domain, mwsSecretKey); ``` Computes the Amazon MWS signature using the `mwsSecretKey` and adds the `Signature` parameter to the request. This method should be called for all Amazon Marketplace Web Service (Amazon MWS) HTTP requests. It should be called after all request parameters have been added. **Important:** The Chilkat v9.5.0.75 release accidentally breaks Amazon MWS (not AWS) authentication. If you need MWS with 9.5.0.75, send email to support@chilkatsoft.com for a hotfix, or revert back to v9.5.0.73, or update to a version after 9.5.0.75. The `domain` should be the domain of the request, such as one of the following: - mws.amazonservices.com - mws-eu.amazonservices.com - mws.amazonservices.in - mws.amazonservices.com.cn - mws.amazonservices.jp Note: This method automatically adds or replaces the existing Timestamp parameter to the current system date/time. Returns True for success, False for failure. ### HttpRequest.AddParam `Chilkat 11.7.0 · ckpython · HttpRequest · AddParam · method` ```python # name is a string # value is a string httpRequest.AddParam(name, value); ``` Adds a request query parameter (name/value pair) to the HTTP request. The `name` and `value` strings passed to this method should not be URL encoded. ### HttpRequest.AddStringForUpload `Chilkat 11.7.0 · ckpython · HttpRequest · AddStringForUpload · method` ```python # name is a string # filename is a string # strData is a string # charset is a string status = httpRequest.AddStringForUpload(name, filename, strData, charset); ``` Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file. Returns True for success, False for failure. ### HttpRequest.AddStringForUpload2 `Chilkat 11.7.0 · ckpython · HttpRequest · AddStringForUpload2 · method` ```python # name is a string # filename is a string # strData is a string # charset is a string # contentType is a string status = httpRequest.AddStringForUpload2(name, filename, strData, charset, contentType); ``` Same as AddStringForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the `filename`'s file extension.) Returns True for success, False for failure. ### HttpRequest.AddSubHeader `Chilkat 11.7.0 · ckpython · HttpRequest · AddSubHeader · method · since 9.5.0.55` ```python # index is an integer # name is a string # value is a string status = httpRequest.AddSubHeader(index, name, value); ``` Adds a request header to the Nth sub-header of the HTTP request. If a header having the same field name is already present, this method replaces it. Returns True for success, False for failure. ### HttpRequest.GenerateRequestFile `Chilkat 11.7.0 · ckpython · HttpRequest · GenerateRequestFile · method · since 9.5.0.64` ```python # path is a string status = httpRequest.GenerateRequestFile(path); ``` The same as GenerateRequestText, except the generated request is written to the file specified by `path`. Returns True for success, False for failure. ### HttpRequest.GenerateRequestText `Chilkat 11.7.0 · ckpython · HttpRequest · GenerateRequestText · method` ```python # outStr is a CkString (output) status = httpRequest.GenerateRequestText(outStr); retStr = httpRequest.generateRequestText(); ``` Returns the request text that would be sent if Http.SynchronousRequest was called. Returns True for success, False for failure. ### HttpRequest.GetHeaderField `Chilkat 11.7.0 · ckpython · HttpRequest · GetHeaderField · method` ```python # name is a string # outStr is a CkString (output) status = httpRequest.GetHeaderField(name, outStr); retStr = httpRequest.getHeaderField(name); ``` Returns the value of a request header field. Returns True for success, False for failure. ### HttpRequest.GetHeaderName `Chilkat 11.7.0 · ckpython · HttpRequest · GetHeaderName · method` ```python # index is an integer # outStr is a CkString (output) status = httpRequest.GetHeaderName(index, outStr); retStr = httpRequest.getHeaderName(index); ``` Returns the Nth request header field name. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property. Returns True for success, False for failure. ### HttpRequest.GetHeaderValue `Chilkat 11.7.0 · ckpython · HttpRequest · GetHeaderValue · method` ```python # index is an integer # outStr is a CkString (output) status = httpRequest.GetHeaderValue(index, outStr); retStr = httpRequest.getHeaderValue(index); ``` Returns the Nth request header field value. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property. Returns True for success, False for failure. ### HttpRequest.GetParam `Chilkat 11.7.0 · ckpython · HttpRequest · GetParam · method` ```python # name is a string # outStr is a CkString (output) status = httpRequest.GetParam(name, outStr); retStr = httpRequest.getParam(name); ``` Returns a request query parameter value by name. Returns True for success, False for failure. ### HttpRequest.GetParamName `Chilkat 11.7.0 · ckpython · HttpRequest · GetParamName · method` ```python # index is an integer # outStr is a CkString (output) status = httpRequest.GetParamName(index, outStr); retStr = httpRequest.getParamName(index); ``` Returns the Nth request query parameter field name. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property. Returns True for success, False for failure. ### HttpRequest.GetParamValue `Chilkat 11.7.0 · ckpython · HttpRequest · GetParamValue · method` ```python # index is an integer # outStr is a CkString (output) status = httpRequest.GetParamValue(index, outStr); retStr = httpRequest.getParamValue(index); ``` Returns the Nth request query parameter field value. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property. Returns True for success, False for failure. ### HttpRequest.GetUrlEncodedParams `Chilkat 11.7.0 · ckpython · HttpRequest · GetUrlEncodedParams · method` ```python # outStr is a CkString (output) status = httpRequest.GetUrlEncodedParams(outStr); retStr = httpRequest.getUrlEncodedParams(); ``` Returns the request parameters in URL encoded form (i.e. in the exact form that would be sent if the ContentType property was application/x-www-form-urlencoded). For example, if a request has two params: param1=`abc 123` and param2=`abc-123`, then GetUrlEncodedParams would return `abc+123¶m2=abc%2D123` Returns True for success, False for failure. ### HttpRequest.LoadBodyFromBd `Chilkat 11.7.0 · ckpython · HttpRequest · LoadBodyFromBd · method · since 9.5.0.67` ```python # requestBody is a CkBinData status = httpRequest.LoadBodyFromBd(requestBody); ``` Uses the contents of the `requestBody` as the HTTP request body. Returns True for success, False for failure. ### HttpRequest.LoadBodyFromFile `Chilkat 11.7.0 · ckpython · HttpRequest · LoadBodyFromFile · method` ```python # filePath is a string status = httpRequest.LoadBodyFromFile(filePath); ``` The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of `filePath`. Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body. Returns True for success, False for failure. ### HttpRequest.LoadBodyFromSb `Chilkat 11.7.0 · ckpython · HttpRequest · LoadBodyFromSb · method · since 9.5.0.67` ```python # requestBody is a CkStringBuilder # charset is a string status = httpRequest.LoadBodyFromSb(requestBody, charset); ``` Uses the contents of the `requestBody` as the HTTP request body. The `charset` indicates the binary representation of the string, such as `utf-8`, `utf-16`, `iso-8859-*`, `windows-125*`, etc. Any of the character encodings supported at the link below are valid. Returns True for success, False for failure. See also: - [Chilkat Supported Character Encodings](http://cknotes.com/chilkat-charsets-character-encodings-supported/) ### HttpRequest.LoadBodyFromString `Chilkat 11.7.0 · ckpython · HttpRequest · LoadBodyFromString · method` ```python # bodyStr is a string # charset is a string status = httpRequest.LoadBodyFromString(bodyStr, charset); ``` The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of `bodyStr`. Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body. `charset` indicates the charset, such as `utf-8` or `iso-8859-1`, to be used. The HTTP body will contain the `bodyStr` converted to this character encoding. Returns True for success, False for failure. ### HttpRequest.RemoveAllParams `Chilkat 11.7.0 · ckpython · HttpRequest · RemoveAllParams · method` ```python httpRequest.RemoveAllParams(); ``` Removes all request parameters. ### HttpRequest.RemoveHeader `Chilkat 11.7.0 · ckpython · HttpRequest · RemoveHeader · method` ```python # name is a string status = httpRequest.RemoveHeader(name); ``` Removes all occurrences of a HTTP request header field. Always returns `True`. Returns True for success, False for failure. ### HttpRequest.RemoveParam `Chilkat 11.7.0 · ckpython · HttpRequest · RemoveParam · method` ```python # name is a string httpRequest.RemoveParam(name); ``` Removes a single HTTP request parameter by name. ### HttpRequest.SetFromUrl `Chilkat 11.7.0 · ckpython · HttpRequest · SetFromUrl · method` ```python # url is a string httpRequest.SetFromUrl(url); ``` Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue). ### HttpRequest.StreamBodyFromFile `Chilkat 11.7.0 · ckpython · HttpRequest · StreamBodyFromFile · method` ```python # filePath is a string status = httpRequest.StreamBodyFromFile(filePath); ``` Useful for sending HTTP requests where the body is a very large file. For example, to send an XML HttpRequest containing a very large XML document, one would set the HttpVerb = `POST`, the ContentType = `text/xml`, and then call StreamBodyFromFile to indicate that the XML body of the request is to be streamed directly from a file. When the HTTP request is actually sent, the body is streamed directly from the file, and thus the file never needs to be loaded in its entirety in memory. Returns True for success, False for failure. ### HttpRequest.StreamChunkFromFile `Chilkat 11.7.0 · ckpython · HttpRequest · StreamChunkFromFile · method · since 9.5.0.55` ```python # path is a string # offset is a string # numBytes is a string status = httpRequest.StreamChunkFromFile(path, offset, numBytes); ``` This method is the same as StreamBodyFromFile, but allows for an offset and number of bytes to be specified. The `offset` and `numBytes` are integers passed as strings. Returns True for success, False for failure. ## Deprecated members — do not use in new code | Member | Kind | Deprecated in | Use instead | |---|---|---|---| | `AddBytesForUpload` | method | before 11.6.1 | — | | `AddBytesForUpload2` | method | before 11.6.1 | — | | `LoadBodyFromBytes` | method | before 11.6.1 | — | ## Related classes [`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckpython/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckpython/classes/StringBuilder.md)