Send a Staged Form-URL-Encoded REST Request

See more REST Examples

Demonstrates Rest.SendReqFormUrlEncoded, which sends an application/x-www-form-urlencoded request whose body is built from the query parameters added to the object.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkRest.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    BOOL bAutoReconnect;
    int statusCode;
    const char *responseBody;

    success = FALSE;

    rest = CkRest_Create();
    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;
    }

    //  The form body is built from the query parameters added to the object.
    CkRest_AddQueryParam(rest,"username","alice");
    CkRest_AddQueryParam(rest,"action","login");

    //  Send the application/x-www-form-urlencoded request.
    success = CkRest_SendReqFormUrlEncoded(rest,"POST","/api/login");
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    //  After sending, read the response status line and header fields.  The return value is the HTTP
    //  status code, or -1 if no response was received.
    statusCode = CkRest_ReadResponseHeader(rest);
    if (statusCode < 0) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    printf("Response status code: %d\n",statusCode);

    //  Read the response body as text.
    responseBody = CkRest_readRespBodyString(rest);
    if (CkRest_getLastMethodSuccess(rest) == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

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


    CkRest_Dispose(rest);

    }