SendCustomRequest Method
Sends a custom request to the Box API.
Syntax
public void sendCustomRequest(String httpMethod, String requestPath, String requestBody);
Remarks
This method can be used to send arbitrary requests to the Box API.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Box 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 Box API endpoint, https://api.box.com/2.0.
- All query parameters in the QueryParams collection 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 ParsedHeaders collection, and the response body in the stream specified using SetDownloadStream, 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.