Sample code for 30+ languages & platforms
Delphi DLL

Add a Path Substitution Parameter to a REST Request

See more REST Examples

Demonstrates Rest.AddPathParam, which adds or replaces a path-substitution parameter. Before a request is sent, each occurrence of the name in the URI path is replaced with its value.

Background. Path parameters keep a URI path template readable—placeholders such as {userId} are substituted with concrete values just before the request is sent.

Chilkat Delphi DLL Downloads

Delphi DLL
var
success: Boolean;
rest: HCkRest;
bTls: Boolean;
bAutoReconnect: Boolean;
responseText: PWideChar;

begin
success := False;

rest := CkRest_Create();

//  Connect to the REST server.  The 3rd argument enables TLS (use 1 for HTTPS on port 443),
//  and the 4th enables automatic reconnection if the connection is dropped between requests.
bTls := True;
bAutoReconnect := True;
success := CkRest_Connect(rest,'example.com',443,bTls,bAutoReconnect);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

//  Add path-substitution parameters.  Before a request is sent, each occurrence of the name in the
//  URI path is replaced with the value.  This keeps the path template readable.
CkRest_AddPathParam(rest,'{userId}','12345');
CkRest_AddPathParam(rest,'{orderId}','98765');

//  The placeholders in the path are replaced before the request is sent.
responseText := CkRest__fullRequestNoBody(rest,'GET','/users/{userId}/orders/{orderId}');
if (CkRest_getLastMethodSuccess(rest) = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;
Memo1.Lines.Add(responseText);

CkRest_Dispose(rest);