CustomRequest Method

Sends a request to the specified URL using the HTTP Method and Post Data provided.

Syntax

odata.customRequest(HTTPMethod, URL, postData, [callback])

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 this 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

Sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g. POST) and the data sent is determined by PostData. If a custom request does not require data to be sent, you can simply set the PostData parameter to an empty string. Note, all values specified are taken as entered.

OtherHeaders can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved via the TransferredHeaders property as well as through the Header event.

The class will then attempt to parse the search results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryProperties.