APIVersion Property

Version of the API you're using to submit a transaction.

Syntax

 azurerequest.getAPIVersion([callback])
 azurerequest.setAPIVersion( APIVersion, [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 getAPIVersion([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 setAPIVersion([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 describes the API version of the current protocol as defined by Azure. There is no default for this property, and it is required for all current APIs.

Azure defines each version as the date it was released. An example is: "2014-02-14".

Data Type

String