Rest Tcl Reference Documentation

Rest

Current Version: 9.5.0.73

API for implementing RESTful Web API's.

Object Creation

set myRest [new CkRest]

Properties

AllowHeaderFolding
boolean 1/0
set boolVal [CkRest_get_AllowHeaderFolding $myRest]
CkRest_put_AllowHeaderFolding $myRest $boolVal
Introduced in version 9.5.0.63

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

top
AllowHeaderQB
boolean 1/0
set boolVal [CkRest_get_AllowHeaderQB $myRest]
CkRest_put_AllowHeaderQB $myRest $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 1.

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 0, then no Q/B encoding is applied to any request header.

top
Authorization
string
# ckStr is a CkString
CkRest_get_Authorization $myRest $ckStr
set strVal [CkRest_get_authorization $myRest]
CkRest_put_Authorization $myRest $strVal
Introduced in version 9.5.0.58

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

top
ConnectFailReason
integer
set intVal [CkRest_get_ConnectFailReason $myRest]
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.

top
ConnectTimeoutMs
integer
set intVal [CkRest_get_ConnectTimeoutMs $myRest]
CkRest_put_ConnectTimeoutMs $myRest $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.

top
DebugLogFilePath
string
# ckStr is a CkString
CkRest_get_DebugLogFilePath $myRest $ckStr
set strVal [CkRest_get_debugLogFilePath $myRest]
CkRest_put_DebugLogFilePath $myRest $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.

top
Host
string
# ckStr is a CkString
CkRest_get_Host $myRest $ckStr
set strVal [CkRest_get_host $myRest]
CkRest_put_Host $myRest $strVal
Introduced in version 9.5.0.58

The value of the Host HTTP request header.

top
IdleTimeoutMs
integer
set intVal [CkRest_get_IdleTimeoutMs $myRest]
CkRest_put_IdleTimeoutMs $myRest $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.

top
LastErrorHtml
string
# ckStr is a CkString
CkRest_get_LastErrorHtml $myRest $ckStr
set strVal [CkRest_get_lastErrorHtml $myRest]

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.

top
LastErrorText
string
# ckStr is a CkString
CkRest_get_LastErrorText $myRest $ckStr
set strVal [CkRest_get_lastErrorText $myRest]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkRest_get_LastErrorXml $myRest $ckStr
set strVal [CkRest_get_lastErrorXml $myRest]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkRest_get_LastMethodSuccess $myRest]
CkRest_put_LastMethodSuccess $myRest $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastRequestHeader
string
# ckStr is a CkString
CkRest_get_LastRequestHeader $myRest $ckStr
set strVal [CkRest_get_lastRequestHeader $myRest]
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.

top
LastRequestStartLine
string
# ckStr is a CkString
CkRest_get_LastRequestStartLine $myRest $ckStr
set strVal [CkRest_get_lastRequestStartLine $myRest]
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.)

top
NumResponseHeaders
integer
set intVal [CkRest_get_NumResponseHeaders $myRest]
Introduced in version 9.5.0.58

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

top
PartSelector
string
# ckStr is a CkString
CkRest_get_PartSelector $myRest $ckStr
set strVal [CkRest_get_partSelector $myRest]
CkRest_put_PartSelector $myRest $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.

top
PercentDoneOnSend
boolean 1/0
set boolVal [CkRest_get_PercentDoneOnSend $myRest]
CkRest_put_PercentDoneOnSend $myRest $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 0, 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 0. If the REST request is to upload a file (using a Full* method), then set this property to 1. 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.

top
ResponseHeader
string
# ckStr is a CkString
CkRest_get_ResponseHeader $myRest $ckStr
set strVal [CkRest_get_responseHeader $myRest]
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).

top
ResponseStatusCode
integer
set intVal [CkRest_get_ResponseStatusCode $myRest]
Introduced in version 9.5.0.58

The response status code.

top
ResponseStatusText
string
# ckStr is a CkString
CkRest_get_ResponseStatusText $myRest $ckStr
set strVal [CkRest_get_responseStatusText $myRest]
Introduced in version 9.5.0.58

The status message corresponding to the response status code.

top
StreamNonChunked
boolean 1/0
set boolVal [CkRest_get_StreamNonChunked $myRest]
CkRest_put_StreamNonChunked $myRest $boolVal
Introduced in version 9.5.0.58

If 1, 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 0, then the chunked transfer encoding is used. The default value of this property is 1.

top
Utf8
boolean 1/0
set boolVal [CkRest_get_Utf8 $myRest]
CkRest_put_Utf8 $myRest $boolVal

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

top
VerboseLogging
boolean 1/0
set boolVal [CkRest_get_VerboseLogging $myRest]
CkRest_put_VerboseLogging $myRest $boolVal

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

top
Version
string
# ckStr is a CkString
CkRest_get_Version $myRest $ckStr
set strVal [CkRest_get_version $myRest]

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

top

Methods

AddHeader
# name is a string
# value is a string
set status [CkRest_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 1 for success, 0 for failure.

top
AddMwsSignature
# httpVerb is a string
# uriPath is a string
# domain is a string
# mwsSecretKey is a string
set status [CkRest_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 1 for success, 0 for failure.

top
AddPathParam
# name is a string
# value is a string
set status [CkRest_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 1 for success, 0 for failure.

top
AddQueryParam
# name is a string
# value is a string
set status [CkRest_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 1 for success, 0 for failure.

top
AddQueryParams
# queryString is a string
set status [CkRest_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 1 for success, 0 for failure.

top
AddQueryParamSb
# name is a string
# value is a CkStringBuilder
set status [CkRest_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 1 for success, 0 for failure.

top
ClearAllHeaders
set status [CkRest_ClearAllHeaders]
Introduced in version 9.5.0.58

Removes all HTTP request headers.

Returns 1 for success, 0 for failure.

top
ClearAllParts
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
ClearAllPathParams
set status [CkRest_ClearAllPathParams]
Introduced in version 9.5.0.70

Clears all path parameters.

Returns 1 for success, 0 for failure.

top
ClearAllQueryParams
set status [CkRest_ClearAllQueryParams]
Introduced in version 9.5.0.58

Clears all query parameters.

Returns 1 for success, 0 for failure.

top
ClearAuth
set status [CkRest_ClearAuth]
Introduced in version 9.5.0.69

Clears all authentication settings.

Returns 1 for success, 0 for failure.

top
ClearResponseBodyStream
CkRest_ClearResponseBodyStream
Introduced in version 9.5.0.58

Clears the response body stream set by calling SetResponseBodyStream.

top
Connect
# hostname is a string
# port is an integer
# tls is a boolean
# autoReconnect is a boolean
set status [CkRest_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 1. 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 1 for success, 0 for failure.

top
ConnectAsync (1)
# returns a CkTask
# hostname is a string
# port is an integer
# tls is a boolean
# autoReconnect is a boolean
set ret_task [CkRest_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 NULL on failure

top
Disconnect
# maxWaitMs is an integer
set status [CkRest_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 1 for success, 0 for failure.

top
DisconnectAsync (1)
# returns a CkTask
# maxWaitMs is an integer
set ret_task [CkRest_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 NULL on failure

top
FullRequestBd
# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
# responseBody is a CkStringBuilder
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
FullRequestBdAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
# responseBody is a CkStringBuilder
set ret_task [CkRest_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 NULL on failure

top
FullRequestBinary
# httpVerb is a string
# uriPath is a string
# bodyBytes is a CkByteData
# outStr is a CkString (output)
set status [CkRest_FullRequestBinary $httpVerb $uriPath $bodyBytes $outStr]
set retStr [CkRest_fullRequestBinary $myRest $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 1 for success, 0 for failure.

More Information and Examples
top
FullRequestBinaryAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodyBytes is a CkByteData
set ret_task [CkRest_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 NULL on failure

top
FullRequestFormUrlEncoded
# httpVerb is a string
# uriPath is a string
# outStr is a CkString (output)
set status [CkRest_FullRequestFormUrlEncoded $httpVerb $uriPath $outStr]
set retStr [CkRest_fullRequestFormUrlEncoded $myRest $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 1 for success, 0 for failure.

top
FullRequestFormUrlEncodedAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
set ret_task [CkRest_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 NULL on failure

top
FullRequestMultipart
# httpVerb is a string
# uriPath is a string
# outStr is a CkString (output)
set status [CkRest_FullRequestMultipart $httpVerb $uriPath $outStr]
set retStr [CkRest_fullRequestMultipart $myRest $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 1 for success, 0 for failure.

top
FullRequestMultipartAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
set ret_task [CkRest_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 NULL on failure

top
FullRequestNoBody
# httpVerb is a string
# uriPath is a string
# outStr is a CkString (output)
set status [CkRest_FullRequestNoBody $httpVerb $uriPath $outStr]
set retStr [CkRest_fullRequestNoBody $myRest $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 1 for success, 0 for failure.

More Information and Examples
top
FullRequestNoBodyAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
set ret_task [CkRest_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 NULL on failure

top
FullRequestNoBodyBd
# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
FullRequestNoBodyBdAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# binData is a CkBinData
set ret_task [CkRest_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 NULL on failure

top
FullRequestNoBodySb
# httpVerb is a string
# uriPath is a string
# sb is a CkStringBuilder
set status [CkRest_FullRequestNoBodySb $httpVerb $uriPath $sb]
Introduced in version 9.5.0.64

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
FullRequestNoBodySbAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# sb is a CkStringBuilder
set ret_task [CkRest_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 NULL on failure

top
FullRequestSb
# httpVerb is a string
# uriPath is a string
# requestBody is a CkStringBuilder
# responseBody is a CkStringBuilder
set status [CkRest_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 1 for success, 0 for failure.

top
FullRequestSbAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# requestBody is a CkStringBuilder
# responseBody is a CkStringBuilder
set ret_task [CkRest_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 NULL on failure

top
FullRequestStream
# httpVerb is a string
# uriPath is a string
# stream is a CkStream
# outStr is a CkString (output)
set status [CkRest_FullRequestStream $httpVerb $uriPath $stream $outStr]
set retStr [CkRest_fullRequestStream $myRest $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 1 for success, 0 for failure.

top
FullRequestStreamAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# stream is a CkStream
set ret_task [CkRest_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 NULL on failure

top
FullRequestString
# httpVerb is a string
# uriPath is a string
# bodyText is a string
# outStr is a CkString (output)
set status [CkRest_FullRequestString $httpVerb $uriPath $bodyText $outStr]
set retStr [CkRest_fullRequestString $myRest $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 1 for success, 0 for failure.

top
FullRequestStringAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodyText is a string
set ret_task [CkRest_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 NULL on failure

top
ReadRespBd
# responseBody is a CkBinData
set status [CkRest_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 1 for success, 0 for failure.

top
ReadRespBdAsync (1)
# returns a CkTask
# responseBody is a CkBinData
set ret_task [CkRest_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 NULL on failure

top
ReadRespBodyBinary
# outBytes is a CkByteData (output)
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
ReadRespBodyBinaryAsync (1)
# returns a CkTask
set ret_task [CkRest_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 NULL on failure

top
ReadRespBodyStream
# stream is a CkStream
# autoSetStreamCharset is a boolean
set status [CkRest_ReadRespBodyStream $stream $autoSetStreamCharset]
Introduced in version 9.5.0.58

Reads the response body to the stream. If autoSetStreamCharset is 1, 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 1 for success, 0 for failure.

top
ReadRespBodyStreamAsync (1)
# returns a CkTask
# stream is a CkStream
# autoSetStreamCharset is a boolean
set ret_task [CkRest_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 NULL on failure

top
ReadRespBodyString
# outStr is a CkString (output)
set status [CkRest_ReadRespBodyString $outStr]
set retStr [CkRest_readRespBodyString $myRest]
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 1 for success, 0 for failure.

More Information and Examples
top
ReadRespBodyStringAsync (1)
# returns a CkTask
set ret_task [CkRest_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 NULL on failure

top
ReadResponseHeader
set retInt [CkRest_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.

More Information and Examples
top
ReadResponseHeaderAsync (1)
# returns a CkTask
set ret_task [CkRest_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 NULL on failure

top
ReadRespSb
# responseBody is a CkStringBuilder
set status [CkRest_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 1 for success, 0 for failure.

top
ReadRespSbAsync (1)
# returns a CkTask
# responseBody is a CkStringBuilder
set ret_task [CkRest_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 NULL on failure

top
RedirectUrl
# returns a CkUrl
set ret_url [CkRest_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 NULL on failure

top
RemoveHeader
# name is a string
set status [CkRest_RemoveHeader $name]
Introduced in version 9.5.0.58

Removes all headers having the given name.

Returns 1 for success, 0 for failure.

top
RemoveQueryParam
# name is a string
set status [CkRest_RemoveQueryParam $name]
Introduced in version 9.5.0.58

Removes all query params having the given name.

Returns 1 for success, 0 for failure.

top
ResponseHdrByName
# name is a string
# outStr is a CkString (output)
set status [CkRest_ResponseHdrByName $name $outStr]
set retStr [CkRest_responseHdrByName $myRest $name]
Introduced in version 9.5.0.58

Returns the value of the response header indicated by name.

Returns 1 for success, 0 for failure.

top
ResponseHdrName
# index is an integer
# outStr is a CkString (output)
set status [CkRest_ResponseHdrName $index $outStr]
set retStr [CkRest_responseHdrName $myRest $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 1 for success, 0 for failure.

More Information and Examples
top
ResponseHdrValue
# index is an integer
# outStr is a CkString (output)
set status [CkRest_ResponseHdrValue $index $outStr]
set retStr [CkRest_responseHdrValue $myRest $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 1 for success, 0 for failure.

More Information and Examples
top
SaveLastError
# path is a string
set status [CkRest_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

top
SendReqBd
# httpVerb is a string
# uriPath is a string
# body is a CkBinData
set status [CkRest_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 1 for success, 0 for failure.

top
SendReqBdAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# body is a CkBinData
set ret_task [CkRest_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 NULL on failure

top
SendReqBinaryBody
# httpVerb is a string
# uriPath is a string
# body is a CkByteData
set status [CkRest_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 1 for success, 0 for failure.

top
SendReqBinaryBodyAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# body is a CkByteData
set ret_task [CkRest_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 NULL on failure

top
SendReqFormUrlEncoded
# httpVerb is a string
# uriPath is a string
set status [CkRest_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 1 for success, 0 for failure.

top
SendReqFormUrlEncodedAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
set ret_task [CkRest_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 NULL on failure

top
SendReqMultipart
# httpVerb is a string
# uriPath is a string
set status [CkRest_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 1 for success, 0 for failure.

top
SendReqMultipartAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
set ret_task [CkRest_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 NULL on failure

top
SendReqNoBody
# httpVerb is a string
# uriPath is a string
set status [CkRest_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 1 for success, 0 for failure.

top
SendReqNoBodyAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
set ret_task [CkRest_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 NULL on failure

top
SendReqSb
# httpVerb is a string
# uriPath is a string
# bodySb is a CkStringBuilder
set status [CkRest_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 1 for success, 0 for failure.

top
SendReqSbAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodySb is a CkStringBuilder
set ret_task [CkRest_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 NULL on failure

top
SendReqStreamBody
# httpVerb is a string
# uriPath is a string
# stream is a CkStream
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SendReqStreamBodyAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# stream is a CkStream
set ret_task [CkRest_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 NULL on failure

top
SendReqStringBody
# httpVerb is a string
# uriPath is a string
# bodyText is a string
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SendReqStringBodyAsync (1)
# returns a CkTask
# httpVerb is a string
# uriPath is a string
# bodyText is a string
set ret_task [CkRest_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 NULL on failure

top
SetAuthAws
# authProvider is a CkAuthAws
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SetAuthAzureAD
# authProvider is a CkAuthAzureAD
set status [CkRest_SetAuthAzureAD $authProvider]
Introduced in version 9.5.0.58

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

Returns 1 for success, 0 for failure.

top
SetAuthAzureSas
# authProvider is a CkAuthAzureSAS
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SetAuthAzureStorage
# authProvider is a CkAuthAzureStorage
set status [CkRest_SetAuthAzureStorage $authProvider]
Introduced in version 9.5.0.58

Sets the authorization service provider for Azure Storage Service requests.

Returns 1 for success, 0 for failure.

top
SetAuthBasic
# username is a string
# password is a string
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SetAuthBasicSecure
# username is a CkSecureString
# password is a CkSecureString
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SetAuthGoogle
# authProvider is a CkAuthGoogle
set status [CkRest_SetAuthGoogle $authProvider]
Introduced in version 9.5.0.58

Sets the authorization service provider for Google API requests.

Returns 1 for success, 0 for failure.

top
SetAuthOAuth1
# authProvider is a CkOAuth1
# useQueryParams is a boolean
set status [CkRest_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 1, then the OAuth1 authentication information and signature is passed in query parameters. Otherwise it is passed in an Authorization header.

Returns 1 for success, 0 for failure.

top
SetAuthOAuth2
# authProvider is a CkOAuth2
set status [CkRest_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 1 for success, 0 for failure.

top
SetMultipartBodyBd
# bodyData is a CkBinData
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SetMultipartBodyBinary
# bodyData is a CkByteData
set status [CkRest_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 1 for success, 0 for failure.

top
SetMultipartBodySb
# bodySb is a CkStringBuilder
set status [CkRest_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 1 for success, 0 for failure.

More Information and Examples
top
SetMultipartBodyStream
# stream is a CkStream
set status [CkRest_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 1 for success, 0 for failure.

top
SetMultipartBodyString
# bodyText is a string
set status [CkRest_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 1 for success, 0 for failure.

top
SetResponseBodyStream
# expectedStatus is an integer
# autoSetStreamCharset is a boolean
# responseStream is a CkStream
set status [CkRest_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 1, 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.

Starting in v9.5.0.75, the expectedStatus may be passed as a negative number to specify a range of expected (success) status codes. For example:

  • -200: Allow status codes 200 - 299
  • -210: Allow status codes 210 - 219
  • -220: Allow status codes 220 - 229
  • etc.

Returns 1 for success, 0 for failure.

More Information and Examples
top
UseConnection
# connection is a CkSocket
# autoReconnect is a boolean
set status [CkRest_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 1 for success, 0 for failure.

top