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.

#include <C_CkRest.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    BOOL bAutoReconnect;
    const char *responseText;

    success = FALSE;

    rest = CkRest_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 = CkRest_Connect(rest,"example.com",443,bTls,bAutoReconnect);
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_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.
    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) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    printf("%s\n",responseText);


    CkRest_Dispose(rest);

    }