ODataVersion Property

The OData Version.

Syntax

 odata.getODataVersion([callback])
 odata.setODataVersion( ODataVersion, [callback])

Possible Values

  0 (odV2), 
  1 (odV3), 
  2 (odV4), 
  3 (odAuto)

Default Value

3

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 getODataVersion([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 setODataVersion([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 specifies the OData version to be used in the request and expected in the response. Possible values are:

• 0 (odV2)
• 1 (odv3)
• 3 (odV4)
• 4 (odAuto - default)

When set to 4 (odAuto - default) the class will automatically determine the version used by the service and use the same version to format requests and parse responses. When calling CreateEntry or UpdateEntry if the service version is not already known from a previous operation the class will first query the service to determine the version.

Once the version of the service has been automatically determined it will continue to be used until Reset is called.

This property is not available at design time.

Data Type

Integer