CkRest Python Reference Documentation

CkRest

API for implementing RESTful Web API's.

Object Creation

obj = chilkat.CkRest()

Properties

# boolVal is a boolean
boolVal = rest.get_AllowHeaderFolding();
rest.put_AllowHeaderFolding(boolVal);

Introduced in version 9.5.0.63

If this property is set to False, then no MIME header folding will be automatically applied to any request header. The default is True. This property is provided to satisfy certain providers, such as Quickbooks, that require all MIME headers to be single unfolded lines regardless of length.

# boolVal is a boolean
boolVal = rest.get_AllowHeaderQB();
rest.put_AllowHeaderQB(boolVal);

Introduced in version 9.5.0.59

Controls whether non us-ascii HTTP request headers are automatically Q/B encoded. The default value is True.

Q/B encoded headers explicitly indicate the charset and byte representation, and appear as such: =?utf-8?Q?...?= or =?utf-8?B?...?=, where the charset may be "utf-8" or any other possible charset.

If this property is set to False, then no Q/B encoding is applied to any request header.

# strVal is a string
# ckStr is a CkString
rest.get_Authorization(ckStr);
strVal = rest.authorization();
rest.put_Authorization(strVal);

Introduced in version 9.5.0.58

The value of the Authorization HTTP request header (if needed).

# intVal is an integer
intVal = rest.get_ConnectFailReason();

Introduced in version 9.5.0.58

If the Connect method fails, this property can be checked to determine the reason for failure.

Possible values are:

0 = success

Normal (non-SSL) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)

SSL/TLS:
100 = TLS internal error.
101 = Failed to send client hello.
102 = Unexpected handshake message.
103 = Failed to read server hello.
104 = No server certificate.
105 = Unexpected TLS protocol version.
106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
107 = Unacceptable TLS protocol version.
109 = Failed to read handshake messages.
110 = Failed to send client certificate handshake message.
111 = Failed to send client key exchange handshake message.
112 = Client certificate's private key not accessible.
113 = Failed to send client cert verify handshake message.
114 = Failed to send change cipher spec handshake message.
115 = Failed to send finished handshake message.
116 = Server's Finished message is invalid.

# intVal is an integer
intVal = rest.get_ConnectTimeoutMs();
rest.put_ConnectTimeoutMs(intVal);

Introduced in version 9.5.0.71

The maximum amount of time to wait for the connection to be accepted by the HTTP server.

Note: Suprisingly, this property was forgotten and not added until Chilkat v9.5.0.71.

# strVal is a string
# ckStr is a CkString
rest.get_DebugLogFilePath(ckStr);
strVal = rest.debugLogFilePath();
rest.put_DebugLogFilePath(strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

# strVal is a string
# ckStr is a CkString
rest.get_Host(ckStr);
strVal = rest.host();
rest.put_Host(strVal);

Introduced in version 9.5.0.58

The value of the Host HTTP request header.

# intVal is an integer
intVal = rest.get_IdleTimeoutMs();
rest.put_IdleTimeoutMs(intVal);

Introduced in version 9.5.0.58

The maximum amount of time to wait for additional incoming data when receiving, or the max time to wait to send additional data. The default value is 30000 (30 seconds). This is not an overall max timeout. Rather, it is the maximum time to wait when receiving or sending has halted.

# strVal is a string
# ckStr is a CkString
rest.get_LastErrorHtml(ckStr);
strVal = rest.lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# strVal is a string
# ckStr is a CkString
rest.get_LastErrorText(ckStr);
strVal = rest.lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
rest.get_LastErrorXml(ckStr);
strVal = rest.lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# boolVal is a boolean
boolVal = rest.get_LastMethodSuccess();
rest.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# strVal is a string
# ckStr is a CkString
rest.get_LastRequestHeader(ckStr);
strVal = rest.lastRequestHeader();

Introduced in version 9.5.0.58

The full MIME header (not including the HTTP start line which contains the status code and status text), of the last request sent.

# strVal is a string
# ckStr is a CkString
rest.get_LastRequestStartLine(ckStr);
strVal = rest.lastRequestStartLine();

Introduced in version 9.5.0.58

The full start line of the last request sent. (The start line begins with the HTTP verb, such as GET, POST, etc., is followed by the URI path, and ends with the HTTP version.)

# intVal is an integer
intVal = rest.get_NumResponseHeaders();

Introduced in version 9.5.0.58

The number of response header fields. The first response header field is at index 0.

# strVal is a string
# ckStr is a CkString
rest.get_PartSelector(ckStr);
strVal = rest.partSelector();
rest.put_PartSelector(strVal);

Introduced in version 9.5.0.58

Only used for multipart requests. Selects the target MIME part for calls to AddHeader, RemoveHeader, SetMultipartBodyBinary, SetMultipartBodyString, SetMultipartBodyStream, etc. The default is an empty string and indicates the top-level header. A string value of "1" would indicate the 1st sub-part in a multipart request. A string value of "1.2" would indicate the 2nd sub-part under the 1st sub-part.

It is unlikely you'll ever encounter the need for nested multipart requests (i.e. part selectors such as "1.2") Also, most REST requests are NOT multipart, and therefore this feature is rarely used. An example of a multipart REST request would be for a Google Drive upload, where the top-level Content-Type is multipart/related, the1st sub-part contains the JSON meta-data, and the 2nd sub-part contains the file data.

Google Drive Multipart Upload String (Google Drive)

# boolVal is a boolean
boolVal = rest.get_PercentDoneOnSend();
rest.put_PercentDoneOnSend(boolVal);

Introduced in version 9.5.0.58

This property only applies to the FullRequest* methods, which are methods that both send an HTTP request and receive the response. (It also only applies to programming languages that support event callbacks.) It determines whether percentage completion is tracked for the sending of the HTTP request, or for the downloading the HTTP response. The default value is False, which is to measure the percent completion when receiving the response.

For example: If the REST request is to download a file, then this property should remain at the default value of False. If the REST request is to upload a file (using a Full* method), then set this property to True. Also note if a server sends an HTTP response in the chunked encoding, it is not possible to measure percent completion because the HTTP client has no way of knowing the total size of the HTTP response.

# strVal is a string
# ckStr is a CkString
rest.get_ResponseHeader(ckStr);
strVal = rest.responseHeader();

Introduced in version 9.5.0.58

The full response MIME header (not including the HTTP start line which contains the status code and status text).

# intVal is an integer
intVal = rest.get_ResponseStatusCode();

Introduced in version 9.5.0.58

The response status code.

# strVal is a string
# ckStr is a CkString
rest.get_ResponseStatusText(ckStr);
strVal = rest.responseStatusText();

Introduced in version 9.5.0.58

The status message corresponding to the response status code.

# boolVal is a boolean
boolVal = rest.get_StreamNonChunked();
rest.put_StreamNonChunked(boolVal);

Introduced in version 9.5.0.58

If True, then methods that upload data are sent non-chunked if possible. For example, if the FullRequestStream method is called where the stream is a file stream, then the size of the content is known and the HTTP request will be sent using a Content-Length header instead of using a Transfer-Encoding: chunked upload. If False, then the chunked transfer encoding is used. The default value of this property is True.

# boolVal is a boolean
boolVal = rest.get_Utf8();
rest.put_Utf8(boolVal);

When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.

# boolVal is a boolean
boolVal = rest.get_VerboseLogging();
rest.put_VerboseLogging(boolVal);

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

# strVal is a string
# ckStr is a CkString
rest.get_Version(ckStr);
strVal = rest.version();

Version of the component/library, such as "9.5.0.63"

Methods

# name is a string
# value is a string
status = rest.AddHeader(name, value);

Introduced in version 9.5.0.58

Adds an HTTP request header. If the header field already exists, then it is replaced.

Returns True for success, False for failure.

# httpVerb is a string
# uriPath is a string
# domain is a string
# mwsSecretKey is a string
status = rest.AddMwsSignature(httpVerb, uriPath, domain, mwsSecretKey);

Introduced in version 9.5.0.66

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.

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

The httpVerb should be the HTTP verb, such as "GET", "POST", etc. The uriPath is the URI path, such as "/Feeds/2009-01-01". In general, the httpVerb and uriPath should be identical to the 1st two args passed to methods such as FullRequestFormUrlEncoded.

Note: This method also automatically adds or replaces the existing Timestamp parameter to the current system date/time.

Returns True for success, False for failure.

MWS List Orders (Amazon Marketplace Web Service)

# name is a string
# value is a string
status = rest.AddPathParam(name, value);

Introduced in version 9.5.0.70

Adds or replaces a path parameter. A path parameter is a string that will be replaced in any uriPath string passed to a method. For example, if name is "fileId" and value is "1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl", then a uriPath argument of "/drive/v3/files/fileId" will be transformed to "/drive/v3/files/1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl" in a method call.

Returns True for success, False for failure.

# name is a string
# value is a string
status = rest.AddQueryParam(name, value);

Introduced in version 9.5.0.58

Adds a query parameter. If the query parameter already exists, then it is replaced.

Returns True for success, False for failure.

# queryString is a string
status = rest.AddQueryParams(queryString);

Introduced in version 9.5.0.58

Adds the query parameters from the queryString. The queryString is a query string of the format field1=value1&field2=value2&field3=value3... where each value is URL encoded.

Returns True for success, False for failure.

# name is a string
# value is a CkStringBuilder
status = rest.AddQueryParamSb(name, value);

Introduced in version 9.5.0.62

Adds a query parameter. If the query parameter already exists, then it is replaced. The parameter value is passed in a StringBuilder object.

Returns True for success, False for failure.

status = rest.ClearAllHeaders();

Introduced in version 9.5.0.58

Removes all HTTP request headers.

Returns True for success, False for failure.

status = rest.ClearAllParts();

Introduced in version 9.5.0.64

Removes all sub-parts from a request. This is useful when preparing the REST object to send a new request after a multipart request has just been sent.

Returns True for success, False for failure.

REST Send multipart/form-data

status = rest.ClearAllPathParams();

Introduced in version 9.5.0.70

Clears all path parameters.

Returns True for success, False for failure.

status = rest.ClearAllQueryParams();

Introduced in version 9.5.0.58

Clears all query parameters.

Returns True for success, False for failure.

status = rest.ClearAuth();

Introduced in version 9.5.0.69

Clears all authentication settings.

Returns True for success, False for failure.

rest.ClearResponseBodyStream();

Introduced in version 9.5.0.58

Clears the response body stream set by calling SetResponseBodyStream.

# hostname is a string
# port is an integer
# tls is a boolean
# autoReconnect is a boolean
status = rest.Connect(hostname, port, tls, autoReconnect);

Introduced in version 9.5.0.58

Establishes an initial connection to a REST server. The hostname can be a domain name or an IP address. Both IPv4 and IPv6 addresses are supported. The port is the port, which is typically 80 or 443. If SSL/TLS is required, then tls should be set to True. The autoReconnect indicates whether connection should automatically be established as needed for subsequent REST requests.

Note: This method is for simple connections that do not require any proxies (HTTP or SOCKS), or SSH tunneling. If a proxy, SSH tunnel, or any other advanced socket feature is required, the Chilkat Socket API can be used to establish the connection. The UseConnection method can then be called to use the pre-established socket connection.

Returns True for success, False for failure.

Simple REST Example

REST Auto Reconnect for Multiple Requests

# returns a CkTask
# hostname is a string
# port is an integer
# tls is a boolean
# autoReconnect is a boolean
ret_task = rest.ConnectAsync(hostname, port, tls, autoReconnect);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# maxWaitMs is an integer
status = rest.Disconnect(maxWaitMs);

Introduced in version 9.5.0.58

Closes the connection with the HTTP server if one is open. This method can be called to ensure the connection is closed. The maxWaitMs is the maximum time in milliseconds to wait for a clean close. If the connection is through an SSH tunnel, this closes the logical channel within the SSH tunnel, and not the connection with the SSH server itself.

Returns True for success, False for failure.

# returns a CkTask
# maxWaitMs is an integer
ret_task = rest.DisconnectAsync(maxWaitMs);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the Disconnect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
# responseBody is a CkStringBuilder
status = rest.FullRequestBd(httpVerb, uriPath, binData, responseBody);

Introduced in version 9.5.0.64

Sends a complete REST request (header + binary body) and receives the full response. The binary body of the request is passed in binData. The response body is returned in responseBody (replacing whatever contents responseBody may have previously held).

Returns True for success, False for failure.

S3 Upload Binary File from BinData

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
# responseBody is a CkStringBuilder
ret_task = rest.FullRequestBdAsync(httpVerb, uriPath, binData, responseBody);

Introduced in version 9.5.0.64

Creates an asynchronous task to call the FullRequestBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# bodyBytes is a CkByteData
# outStr is a CkString (output)
status = rest.FullRequestBinary(httpVerb, uriPath, bodyBytes, outStr);
retStr = rest.fullRequestBinary(httpVerb, uriPath, bodyBytes);

Introduced in version 9.5.0.58

Sends a complete REST request (header + body) and receives the full response. It is assumed that the request body is binary, and the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqBinaryBody, ReadResponseHeader, ReadRespBodyString.

Returns True for success, False for failure.

Put Blob: Upload Binary Data to Block Blob

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodyBytes is a CkByteData
ret_task = rest.FullRequestBinaryAsync(httpVerb, uriPath, bodyBytes);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# outStr is a CkString (output)
status = rest.FullRequestFormUrlEncoded(httpVerb, uriPath, outStr);
retStr = rest.fullRequestFormUrlEncoded(httpVerb, uriPath);

Introduced in version 9.5.0.58

Sends a complete application/x-www-form-urlencoded HTTP request and receives the full response. The request body is composed of the URL encoded query params. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqFormUrlEncoded, ReadResponseHeader, ReadRespBodyString.

Returns True for success, False for failure.

Twilio: Send SMS using Basic Authentication

# returns a CkTask
# httpVerb is a string
# uriPath is a string
ret_task = rest.FullRequestFormUrlEncodedAsync(httpVerb, uriPath);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestFormUrlEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# outStr is a CkString (output)
status = rest.FullRequestMultipart(httpVerb, uriPath, outStr);
retStr = rest.fullRequestMultipart(httpVerb, uriPath);

Introduced in version 9.5.0.58

Sends a complete multipart REST request (header + multipart body) and receives the full response. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqMultipart, ReadResponseHeader, ReadRespBodyString.

Returns True for success, False for failure.

Google Drive Multipart Upload String (Google Drive)

# returns a CkTask
# httpVerb is a string
# uriPath is a string
ret_task = rest.FullRequestMultipartAsync(httpVerb, uriPath);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestMultipart method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# outStr is a CkString (output)
status = rest.FullRequestNoBody(httpVerb, uriPath, outStr);
retStr = rest.fullRequestNoBody(httpVerb, uriPath);

Introduced in version 9.5.0.58

Sends a complete REST request and receives the full response. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqNoBody, ReadResponseHeader, ReadRespBodyString.

Returns True for success, False for failure.

Simple REST Example

Geolocation of IP Address

# returns a CkTask
# httpVerb is a string
# uriPath is a string
ret_task = rest.FullRequestNoBodyAsync(httpVerb, uriPath);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestNoBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
status = rest.FullRequestNoBodyBd(httpVerb, uriPath, binData);

Introduced in version 9.5.0.64

The same as FullRequestNoBody, except returns the response body in the binData. This method is useful for downloading binary files.

Returns True for success, False for failure.

Xero Get File Content (Files API)

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
ret_task = rest.FullRequestNoBodyBdAsync(httpVerb, uriPath, binData);

Introduced in version 9.5.0.64

Creates an asynchronous task to call the FullRequestNoBodyBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# sb is a CkStringBuilder
status = rest.FullRequestNoBodySb(httpVerb, uriPath, sb);

Introduced in version 9.5.0.64

The same as FullRequestNoBody, except returns the response body in the sb.

Returns True for success, False for failure.

Xero Get Accounts using REST API

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# sb is a CkStringBuilder
ret_task = rest.FullRequestNoBodySbAsync(httpVerb, uriPath, sb);

Introduced in version 9.5.0.64

Creates an asynchronous task to call the FullRequestNoBodySb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# requestBody is a CkStringBuilder
# responseBody is a CkStringBuilder
status = rest.FullRequestSb(httpVerb, uriPath, requestBody, responseBody);

Introduced in version 9.5.0.62

Sends a complete REST request (header + body string) and receives the full response. The body of the request is passed in requestBody. The response body is returned in responseBody (replacing whatever contents responseBody may have previously held).

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# requestBody is a CkStringBuilder
# responseBody is a CkStringBuilder
ret_task = rest.FullRequestSbAsync(httpVerb, uriPath, requestBody, responseBody);

Introduced in version 9.5.0.62

Creates an asynchronous task to call the FullRequestSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# stream is a CkStream
# outStr is a CkString (output)
status = rest.FullRequestStream(httpVerb, uriPath, stream, outStr);
retStr = rest.fullRequestStream(httpVerb, uriPath, stream);

Introduced in version 9.5.0.58

Sends a complete REST request and receives the full response. It is assumed that the response body is a string (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqStream, ReadResponseHeader, ReadRespBodyString.

Returns True for success, False for failure.

REST File Streaming Upload

AWS S3 File Streaming Upload

REST Asynchronous Streaming Upload Simplified

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# stream is a CkStream
ret_task = rest.FullRequestStreamAsync(httpVerb, uriPath, stream);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# bodyText is a string
# outStr is a CkString (output)
status = rest.FullRequestString(httpVerb, uriPath, bodyText, outStr);
retStr = rest.fullRequestString(httpVerb, uriPath, bodyText);

Introduced in version 9.5.0.58

Sends a complete REST request (header + body string) and receives the full response. It is assumed that both the request and response bodies are strings (such as JSON or XML). The response body is returned.

This method is the equivalent of making the following calls in sequence: SendReqStringBody, ReadResponseHeader, ReadRespBodyString.

Returns True for success, False for failure.

Send JSON REST Request, Get JSON Response

REST Upload String

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodyText is a string
ret_task = rest.FullRequestStringAsync(httpVerb, uriPath, bodyText);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the FullRequestString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# responseBody is a CkBinData
status = rest.ReadRespBd(responseBody);

Introduced in version 9.5.0.62

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body is binary, such as for JPG images or other non-text binary file types. The response body is received into responseBody (replacing whatever contents responseBody may have previously held).

Returns True for success, False for failure.

# returns a CkTask
# responseBody is a CkBinData
ret_task = rest.ReadRespBdAsync(responseBody);

Introduced in version 9.5.0.62

Creates an asynchronous task to call the ReadRespBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# outBytes is a CkByteData (output)
status = rest.ReadRespBodyBinary(outData);

Introduced in version 9.5.0.58

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body is binary, such as for JPG images or other non-text binary file types.

Returns True for success, False for failure.

REST Download Binary to Memory (CkByteData)

# returns a CkTask
ret_task = rest.ReadRespBodyBinaryAsync();

Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadRespBodyBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# stream is a CkStream
# autoSetStreamCharset is a boolean
status = rest.ReadRespBodyStream(stream, autoSetStreamCharset);

Introduced in version 9.5.0.58

Reads the response body to the stream. If autoSetStreamCharset is True, then the stream's StringCharset property will automatically get set based on the charset, if any, indicated in the response header. If the response is binary, then autoSetStreamCharset is ignored.

Returns True for success, False for failure.

REST Stream Response to File (Streaming Download)

REST Read Response with Stream API

Firebase Receive Server-Sent Events (text/event-stream)

HTTP POST and Stream Response to File

# returns a CkTask
# stream is a CkStream
# autoSetStreamCharset is a boolean
ret_task = rest.ReadRespBodyStreamAsync(stream, autoSetStreamCharset);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadRespBodyStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# outStr is a CkString (output)
status = rest.ReadRespBodyString(outStr);
retStr = rest.readRespBodyString();

Introduced in version 9.5.0.58

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body will be a string (such as XML, JSON, etc.)

Returns True for success, False for failure.

Lower-Level REST API Methods

# returns a CkTask
ret_task = rest.ReadRespBodyStringAsync();

Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadRespBodyString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

retInt = rest.ReadResponseHeader();

Introduced in version 9.5.0.58

Reads the HTTP response header. If the HTTP response includes a body, then the application must call the desired method to read the response body. Otherwise, the HTTP request / response is finished after reading the response header (such as for a GET request). The contents of the response header are available in various properties and methods.

The HTTP response status code is returned (such as 200 for a typical success response). If an error occurred such that no response was received, then a value of -1 is returned.

Lower-Level REST API Methods

# returns a CkTask
ret_task = rest.ReadResponseHeaderAsync();

Introduced in version 9.5.0.58

Creates an asynchronous task to call the ReadResponseHeader method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# responseBody is a CkStringBuilder
status = rest.ReadRespSb(responseBody);

Introduced in version 9.5.0.62

Reads the response body. Should only be called after ReadResponseHeader has been called, and should only be called when it is already known that the response body will be a string (such as XML, JSON, etc.) The response body is stored in responseBody. (replacing whatever contents responseBody may have previously held).

Returns True for success, False for failure.

# returns a CkTask
# responseBody is a CkStringBuilder
ret_task = rest.ReadRespSbAsync(responseBody);

Introduced in version 9.5.0.62

Creates an asynchronous task to call the ReadRespSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# returns a CkUrl
ret_url = rest.RedirectUrl();

Introduced in version 9.5.0.58

If the response was a redirect and contains a Location header field, this method returns the redirect URL.

Returns None on failure

# name is a string
status = rest.RemoveHeader(name);

Introduced in version 9.5.0.58

Removes all headers having the given name.

Returns True for success, False for failure.

# name is a string
status = rest.RemoveQueryParam(name);

Introduced in version 9.5.0.58

Removes all query params having the given name.

Returns True for success, False for failure.

# name is a string
# outStr is a CkString (output)
status = rest.ResponseHdrByName(name, outStr);
retStr = rest.responseHdrByName(name);

Introduced in version 9.5.0.58

Returns the value of the response header indicated by name.

Returns True for success, False for failure.

Azure Storage: Create Container

Download File from Dropbox into a String Variable

Fetch S3 Object Metadata

# index is an integer
# outStr is a CkString (output)
status = rest.ResponseHdrName(index, outStr);
retStr = rest.responseHdrName(index);

Introduced in version 9.5.0.58

Returns the name of the Nth response header field. (Chilkat always uses 0-based indexing. The first header field is at index 0.)

Returns True for success, False for failure.

Fetch S3 Object Metadata

# index is an integer
# outStr is a CkString (output)
status = rest.ResponseHdrValue(index, outStr);
retStr = rest.responseHdrValue(index);

Introduced in version 9.5.0.58

Returns the value of the Nth response header field. (Chilkat always uses 0-based indexing. The first header field is at index 0.)

Returns True for success, False for failure.

Fetch S3 Object Metadata

# path is a string
status = rest.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

# httpVerb is a string
# uriPath is a string
# body is a CkBinData
status = rest.SendReqBd(httpVerb, uriPath, body);

Introduced in version 9.5.0.62

Sends a REST request that cotnains a binary body. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The body contains the bytes of the HTTP request body.

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# body is a CkBinData
ret_task = rest.SendReqBdAsync(httpVerb, uriPath, body);

Introduced in version 9.5.0.62

Creates an asynchronous task to call the SendReqBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# body is a CkByteData
status = rest.SendReqBinaryBody(httpVerb, uriPath, body);

Introduced in version 9.5.0.58

Sends a REST request that cotnains a binary body. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The body contains the bytes of the HTTP request body.

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# body is a CkByteData
ret_task = rest.SendReqBinaryBodyAsync(httpVerb, uriPath, body);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqBinaryBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
status = rest.SendReqFormUrlEncoded(httpVerb, uriPath);

Introduced in version 9.5.0.58

Sends an application/x-www-form-urlencoded HTTP request where the body is composed of the URL encoded query params. The httpVerb is the HTTP verb (also known as the HTTP method), such as "POST". The uriPath is the path of the resource URI. If the Content-Type header was set, it is ignored and instead the Content-Type of the request will be "application/x-www-form-urlencoded".

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
ret_task = rest.SendReqFormUrlEncodedAsync(httpVerb, uriPath);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqFormUrlEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
status = rest.SendReqMultipart(httpVerb, uriPath);

Introduced in version 9.5.0.58

Sends a multipart REST request. The httpVerb is the HTTP verb (also known as the HTTP method), such as "GET". The uriPath is the path of the resource URI.

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
ret_task = rest.SendReqMultipartAsync(httpVerb, uriPath);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqMultipart method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
status = rest.SendReqNoBody(httpVerb, uriPath);

Introduced in version 9.5.0.58

Sends a REST request that cotnains no body. The httpVerb is the HTTP verb (also known as the HTTP method), such as "GET". The uriPath is the path of the resource URI.

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
ret_task = rest.SendReqNoBodyAsync(httpVerb, uriPath);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqNoBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# bodySb is a CkStringBuilder
status = rest.SendReqSb(httpVerb, uriPath, bodySb);

Introduced in version 9.5.0.62

Sends a REST request that cotnains a text body, such as XML or JSON. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The bodySb contains the text of the HTTP request body.

Returns True for success, False for failure.

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodySb is a CkStringBuilder
ret_task = rest.SendReqSbAsync(httpVerb, uriPath, bodySb);

Introduced in version 9.5.0.62

Creates an asynchronous task to call the SendReqSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# stream is a CkStream
status = rest.SendReqStreamBody(httpVerb, uriPath, stream);

Introduced in version 9.5.0.58

Sends a REST request that cotnains a binary or text body that is obtained by reading from the stream. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI.

Returns True for success, False for failure.

REST Asynchronous Streaming Upload

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# stream is a CkStream
ret_task = rest.SendReqStreamBodyAsync(httpVerb, uriPath, stream);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqStreamBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# httpVerb is a string
# uriPath is a string
# bodyText is a string
status = rest.SendReqStringBody(httpVerb, uriPath, bodyText);

Introduced in version 9.5.0.58

Sends a REST request that cotnains a text body, such as XML or JSON. The httpVerb is the HTTP verb (also known as the HTTP method), such as "PUT". The uriPath is the path of the resource URI. The bodyText contains the text of the HTTP request body.

Returns True for success, False for failure.

Lower-Level REST API Methods

# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodyText is a string
ret_task = rest.SendReqStringBodyAsync(httpVerb, uriPath, bodyText);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the SendReqStringBody method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns None on failure

How to Run an Asynchronous Task

# authProvider is a CkAuthAws
status = rest.SetAuthAws(authProvider);

Introduced in version 9.5.0.58

Sets the authorization service provider for Amazon AWS REST requests. An application that sets an AWS authentication provider need not explicitly set the Authorization property. Each REST request is automatically signed and authenticated using the authProvider.

Returns True for success, False for failure.

REST through HTTP Proxy

# authProvider is a CkAuthAzureAD
status = rest.SetAuthAzureAD(authProvider);

Introduced in version 9.5.0.58

Sets the Azure AD (Active Directory) authorization service provider.

Returns True for success, False for failure.

# authProvider is a CkAuthAzureSAS
status = rest.SetAuthAzureSas(authProvider);

Introduced in version 9.5.0.65

Provides the information for Azure SAS (Shared Access Signature) authorization. Calling this method will cause the "Authorization: SharedAccessSignature ..." header to be automatically added to all requests.

Returns True for success, False for failure.

Azure Service Bus - Create Queue

# authProvider is a CkAuthAzureStorage
status = rest.SetAuthAzureStorage(authProvider);

Introduced in version 9.5.0.58

Sets the authorization service provider for Azure Storage Service requests.

Returns True for success, False for failure.

Azure Storage Blob Simple Upload

Azure Blob Service - List all Containers in a Storage Account

# username is a string
# password is a string
status = rest.SetAuthBasic(username, password);

Introduced in version 9.5.0.58

Sets the username and password to be used for Basic authentication. This method should be called when Basic authentication is required. It should only be used with secure SSL/TLS connections. Calling this method will cause the "Authorization: Basic ..." header to be automatically added to all requests. In many cases, a REST API will support Basic authentication where the username is a client ID or account ID, and the password is a client secret or token.

Returns True for success, False for failure.

Twilio: Send SMS using Basic Authentication

# username is a CkSecureString
# password is a CkSecureString
status = rest.SetAuthBasicSecure(username, password);

Introduced in version 9.5.0.71

The same as SetAuthBasic, but provides a more secure means for passing the arguments as secure string objects.

Returns True for success, False for failure.

REST Basic Auth with Secure Strings

# authProvider is a CkAuthGoogle
status = rest.SetAuthGoogle(authProvider);

Introduced in version 9.5.0.58

Sets the authorization service provider for Google API requests.

Returns True for success, False for failure.

# authProvider is a CkOAuth1
# useQueryParams is a boolean
status = rest.SetAuthOAuth1(authProvider, useQueryParams);

Introduced in version 9.5.0.58

Sets the authentication provider for REST API requests needing OAuth 1.0 (and OAuth 1.0a) authentication. If useQueryParams is True, then the OAuth1 authentication information and signature is passed in query parameters. Otherwise it is passed in an Authorization header.

Returns True for success, False for failure.

WooCommerce OAuth 1.0a “one-legged” Authentication

# authProvider is a CkOAuth2
status = rest.SetAuthOAuth2(authProvider);

Introduced in version 9.5.0.59

Sets the authentication provider for REST API requests needing standards-based OAuth 2.0 authentication. This is for the case where a desktop/native/mobile application will be popping up a web browser, or embedding a web browser, to get authorization interactively from end-user of the application.

Returns True for success, False for failure.

# bodyData is a CkBinData
status = rest.SetMultipartBodyBd(bodyData);

Introduced in version 9.5.0.62

Only used for multipart requests. Sets the binary content of the multipart body indicated by the PartSelector.

Returns True for success, False for failure.

REST Send multipart/form-data

# bodyData is a CkByteData
status = rest.SetMultipartBodyBinary(bodyData);

Introduced in version 9.5.0.58

Only used for multipart requests. Sets the binary content of the multipart body indicated by the PartSelector.

Returns True for success, False for failure.

# bodySb is a CkStringBuilder
status = rest.SetMultipartBodySb(bodySb);

Introduced in version 9.5.0.62

Only used for multipart requests. Sets the text content of the multipart body indicated by the PartSelector.

Returns True for success, False for failure.

REST Send multipart/form-data

# stream is a CkStream
status = rest.SetMultipartBodyStream(stream);

Introduced in version 9.5.0.58

Only used for multipart requests. Sets the stream source of the multipart body indicated by the PartSelector.

Returns True for success, False for failure.

# bodyText is a string
status = rest.SetMultipartBodyString(bodyText);

Introduced in version 9.5.0.58

Only used for multipart requests. Sets the text content of the multipart body indicated by the PartSelector.

Returns True for success, False for failure.

# expectedStatus is an integer
# autoSetStreamCharset is a boolean
# responseStream is a CkStream
status = rest.SetResponseBodyStream(expectedStatus, autoSetStreamCharset, responseStream);

Introduced in version 9.5.0.58

Only applies to the Full* methods, such as FullRequestNoBody, FullRequestBinary, FullRequestStream, etc. When set, the response body is streamed directly to responseStream, if (and only if) the HTTP response status code equals expectedStatus.

If the response body was streamed to responseStream, then the string return value of the Full* method instead becomes "OK" for success. If an attempt was made to stream the response body but it failed, then "FAIL" is returned. If the response body was not streamed because the response status code was not equal to expectedStatus, then the returned string contains the server's error response.

If autoSetStreamCharset is True, then the expectedStatus's StringCharset property will automatically get set based on the charset, if any, indicated in the response header. If the response is binary, then autoSetStreamCharset is ignored.

Returns True for success, False for failure.

Download File from Dropbox

# connection is a CkSocket
# autoReconnect is a boolean
status = rest.UseConnection(connection, autoReconnect);

Introduced in version 9.5.0.58

Sets the connection to be used for sending the REST request. The connection should be an already-connected socket. It may be a TLS connection, an unencrypted connection, through an HTTP proxy, a SOCKS proxy, or even through SSH tunnels. All of the connection related functionality is handled by the Chilkat Socket API.

The autoReconnect indicates whether connection should automatically be established as needed for subsequent REST requests.

Important: The UseConnection method is provided as a means for handling more complicated connections -- such as connections through proxies, tunnels, etc. If your application is connecting directly to the HTTP server, then simply call this class's Connect method.

Returns True for success, False for failure.

Use Socket Object for the Connection

REST through HTTP Proxy

REST through SOCKS Proxy

REST through SSH Tunnel

REST Upload Bandwidth Throttle