URL Property

The URL to use to make the request.

Syntax

public String getURL();
public void setURL(String URL);

Remarks

This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme, URLServer, URLPort, and URLPath properties.

This property contains the URL to use to make the request when SendRequest is called. When this property is set, its value is parsed in order to populate the URLScheme, URLServer, URLPort, and URLPath properties.

The URL path can contain one or more templates (or "URL parameters"), in the form {NAME}. For example, the URL shown below contains a single URL parameter named FOLDER_ID:

https://api.box.com/2.0/folders/{FOLDER_ID}/items

If the URL contains URL parameters, the URLParameters property will be used to populate them with values when SendRequest is called. You can use the AddURLParam to add items to the URLParameters property, or modify it directly.

Note: URL parameters are not to be confused with query parameters, which are appended onto the end of the URL when SendRequest is called. Query parameters are specified using the QueryParameters property, which can be modified directly or by using the AddQueryParam method.

Default Value

""