Sample code for 30+ languages & platforms
Unicode C

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 Unicode C Downloads

Unicode C
#include <C_CkRestW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRestW rest;
    BOOL bTls;
    BOOL bAutoReconnect;
    const wchar_t *responseText;

    success = FALSE;

    rest = CkRestW_Create();

    //  Connect to the REST server.  The 3rd argument enables TLS (use TRUE for HTTPS on port 443),
    //  and the 4th enables automatic reconnection if the connection is dropped between requests.
    bTls = TRUE;
    bAutoReconnect = TRUE;
    success = CkRestW_Connect(rest,L"example.com",443,bTls,bAutoReconnect);
    if (success == FALSE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        return;
    }

    //  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.
    CkRestW_AddPathParam(rest,L"{userId}",L"12345");
    CkRestW_AddPathParam(rest,L"{orderId}",L"98765");

    //  The placeholders in the path are replaced before the request is sent.
    responseText = CkRestW_fullRequestNoBody(rest,L"GET",L"/users/{userId}/orders/{orderId}");
    if (CkRestW_getLastMethodSuccess(rest) == FALSE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        return;
    }

    wprintf(L"%s\n",responseText);


    CkRestW_Dispose(rest);

    }