(Xojo Plugin) REST URL Encode Path Parts and Query Params

See more REST Examples

When passing a path to a Chilkat REST function, the path parts and query params should be URL encoded. This example explains..

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This example demonstrates how to URL encode the path passed to a REST function.
// It is demonstrated with an Amazon SP API GET request to get details about a listings item for a selling partner.
// See https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#getlistingsitem

Dim rest As New Chilkat.Rest

// Connect to the REST server.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("sellingpartnerapi-eu.amazon.com",port,bTls,bAutoReconnect)

success = rest.ClearAllQueryParams()
success = rest.AddQueryParam("marketplaceids","XYZABC123")
success = rest.AddQueryParam("includedData","offers")

success = rest.AddHeader("x-amz-access-token","YOUR_ACCESS_TOKEN")

Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "YOUR_AWS_APP_ID"
authAws.SecretKey = "YOUR_AWS_APP_SECRET_KEY"
authAws.Region = "eu-west-1"
authAws.ServiceName = "execute-api"
success = rest.SetAuthAws(authAws)

// The path that is passed to FullRequestNobBody

// Here's a sample path that is not yet URL encoded.
Dim path As String
path = "/listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS(BOXED)"

// The path passed to FullRequestNoBody needs to have the parts URL-encoded.
// The "/" chars are not URL encoded, but the individual path parts should be URL encoded.
// For example:  /listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS%28BOXED%29

// In this case, we'll prepare the path like this:
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("100x100_28g_LANCETS(BOXED)")
// URL encode the contents of the sbPath.
success = sbPath.Encode("url","utf-8")
// Prepend the remaining which does not need to be URL encoded.
success = sbPath.Prepend("/listings/2022-07-01/items/ABCDEFGHIJ/")

System.DebugLog("URL encoded path: " + sbPath.GetAsString())

Dim responseJson As String
responseJson = rest.FullRequestNoBody("GET",sbPath.GetAsString())
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

System.DebugLog(responseJson)
System.DebugLog("----")