SendCustomRequest Method
Sends a custom request to the Microsoft Graph API.
Syntax
int SendCustomRequest(const QString& qsHttpMethod, const QString& qsRequestPath, const QString& qsRequestBody);
Remarks
This method can be used to send arbitrary requests to the Microsoft Graph API.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- PATCH
- DELETE
The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Microsoft Graph API. The RequestBody parameter may be empty if not needed.
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, as follows:
- The specified RequestPath is appended to the Microsoft Graph API's "stable" endpoint, https://graph.microsoft.com/v1.0 (however, see note below).
- All query parameters in the QueryParam* properties are added to the request URL.
- Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
- Stores the response headers in the ParsedHeader* properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
Note: Some responses returned by the Graph API include fully-qualified Graph API URLs for clients to use to obtain additional information (the next page of results in a listing, details about a long-running operation, etc.). As a convenience, any fully-qualified URL that begins with https://graph.microsoft.com/ can be passed for RequestPath to have the class make a request against it.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)