PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_AuthAws
string ls_Path
oleobject loo_SbPath
string ls_ResponseJson

li_Success = 0

// 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

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to the REST server.
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("sellingpartnerapi-eu.amazon.com",li_Port,li_BTls,li_BAutoReconnect)

loo_Rest.ClearAllQueryParams()
loo_Rest.AddQueryParam("marketplaceids","XYZABC123")
loo_Rest.AddQueryParam("includedData","offers")

loo_Rest.AddHeader("x-amz-access-token","YOUR_ACCESS_TOKEN")

loo_AuthAws = create oleobject
li_rc = loo_AuthAws.ConnectToNewObject("Chilkat.AuthAws")

loo_AuthAws.AccessKey = "YOUR_AWS_APP_ID"
loo_AuthAws.SecretKey = "YOUR_AWS_APP_SECRET_KEY"
loo_AuthAws.Region = "eu-west-1"
loo_AuthAws.ServiceName = "execute-api"
loo_Rest.SetAuthAws(loo_AuthAws)

// The path that is passed to FullRequestNobBody

// Here's a sample path that is not yet URL encoded.
ls_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:
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("100x100_28g_LANCETS(BOXED)")
// URL encode the contents of the sbPath.
loo_SbPath.Encode("url","utf-8")
// Prepend the remaining which does not need to be URL encoded.
loo_SbPath.Prepend("/listings/2022-07-01/items/ABCDEFGHIJ/")

Write-Debug "URL encoded path: " + loo_SbPath.GetAsString()

ls_ResponseJson = loo_Rest.FullRequestNoBody("GET",loo_SbPath.GetAsString())
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    destroy loo_SbPath
    return
end if

Write-Debug ls_ResponseJson
Write-Debug "----"


destroy loo_Rest
destroy loo_AuthAws
destroy loo_SbPath