Request Responses

This section describes the request responses. The following responses are returned by REST Web service operations.

code

This is the returned HTTP response code. If the HTTP services or resource request is successful, the HTTP response code that is returned is in the 2XX range. By default, if this code is outside the success range, RESTCaller throws a RESTCallerFault. If the returnAllHttpCodes option is set to true, all HTTP response codes are returned.

message

This is the returned HTTP response message. By default, if the HTTP response code is outside the success range, RESTCaller throws a RESTCallerFault. If the returnAllHttpCodes option is set to true, all HTTP response codes are returned along with the corresponding HTTP response message.

resultString

Returns the HTTP body text, unless RESTCaller can return the response body formatted as XML. If the response body can be formatted as XML, this field is empty unless the copyResultAsText option is set to true.

resultXML

Returns the HTTP body text if RESTCaller can return the response body formatted as XML.

resultHeaders

Returns the HTTP headers from the REST service response in the form of an array of structures containing name and value.