REST Response

The REST response is a simple XML block.

A method call returns the following:

  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <response status="success">  
  3.   <format>rest-xml</format>  
  4.   <version>2.0</version>  
  5.   {RESPONSE-BODY}   
  6. </response>  


If an error occurs, the following will be returned:


  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <response status="fail">  
  3.   <format>rest-xml</format>  
  4.   <version>2.0</version>  
  5.   <error-code>{error-code}</error-code>  
  6.   <error-message>{error-message}</error-message>  
  7.   <error-exception>{stacktrace}</error-exception>  
  8. </response>