ServiceRootURI Property

The root URI of an OData service.

Syntax

 odata.getServiceRootURI([callback])
 odata.setServiceRootURI( serviceRootURI, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getServiceRootURI([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setServiceRootURI([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath (ServiceRootURI/ResourcePath) to query feeds and modify entries.

For example, the ServiceRootURI of the OData sample service is: "http://services.odata.org/OData/OData.svc/".

This property is not available at design time.

Data Type

String