Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Unicode C) REST with Query ParamsSee more REST ExamplesDemonstrates how to add query params for a REST request.
#include <C_CkRestW.h> void ChilkatSample(void) { HCkRestW rest; BOOL bTls; int port; BOOL bAutoReconnect; BOOL success; const wchar_t *responseJson; // This example requires the Chilkat API to have been previously unlocked. // See Global Unlock Sample for sample code. // Let's say we want to send a GET request to // https://example.com/search?query=hello%20world&category=books&sortBy=price&filterBy=inStock // Notice that the query parameter values must be URL encoded. // Let's also explain the parts of the above URL: // Scheme: https // The scheme specifies the protocol used to access the resource. // In this case, it is "https," which indicates that the resource is accessed using the Hypertext Transfer Protocol Secure (HTTPS). // // Host: example.com // The host part of the URL identifies the domain name or IP address of the server hosting the resource. In this case, "example.com" is the host. // // Path: /search // The path is the specific location or resource on the server that the client wants to access. // In this URL, the path is "/search," indicating that the client is requesting the "search" resource on the server. // // Query Parameters: // Query parameters are used to send additional data to the server as key-value pairs. // They are separated from the path by a question mark ? and each parameter is separated by an ampersand &. // // The above URL has four query parameters: // query=hello%20world: The "query" parameter with the value "hello world". The %20 represents the URL-encoded space character in the value. // category=books: The "category" parameter with the value "books". // sortBy=price: The "sortBy" parameter with the value "price". // filterBy=inStock: The "filterBy" parameter with the value "inStock". rest = CkRestW_Create(); // Connect to the REST server. // The Host part of the URL is passed in the 1st argument. // The Scheme part of the URL ("https") is indicated by the 2nd and 3rd arguments (port and bTls). bTls = TRUE; port = 443; bAutoReconnect = TRUE; success = CkRestW_Connect(rest,L"example.com",port,bTls,bAutoReconnect); // There are 3 ways to send the above GET request. // 1) Send the request with path and query params pre-built, where the query param values are URL encoded. responseJson = CkRestW_fullRequestNoBody(rest,L"GET",L"/search?query=hello%20world&category=books&sortBy=price&filterBy=inStock"); if (CkRestW_getLastMethodSuccess(rest) != TRUE) { wprintf(L"%s\n",CkRestW_lastErrorText(rest)); CkRestW_Dispose(rest); return; } // 2) Pass only the Path part of the URL, and specify the query params separately by calling AddQueryParams beforehand. // Again, the query params must be already URL encoded when passed to AddQueryParams CkRestW_ClearAllQueryParams(rest); CkRestW_AddQueryParams(rest,L"query=hello%20world&category=books&sortBy=price&filterBy=inStock"); responseJson = CkRestW_fullRequestNoBody(rest,L"GET",L"/search"); // ... // ... // 3) Pass each query parameter separately by calling AddQueryParam. In this case, the query param value should be passed without URL encoding. // (ClearAllQueryParams ensures any params set for previous request are cleared.) CkRestW_ClearAllQueryParams(rest); CkRestW_AddQueryParam(rest,L"query",L"hello world"); CkRestW_AddQueryParam(rest,L"category",L"books"); CkRestW_AddQueryParam(rest,L"sortBy",L"price"); CkRestW_AddQueryParam(rest,L"filterBy",L"inStock"); responseJson = CkRestW_fullRequestNoBody(rest,L"GET",L"/search"); // ... // ... CkRestW_Dispose(rest); } |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.