Services.getErrors

The Errors is a server side JavaScript object that contains functions that allows the creation of customizable error handling functionality specifically returned from the server, for example a 404 HTTP Not Found error. The error handlers are created using a description string and an error code. The errors are as follows:

• com.ebasetech.xi.services.HttpRequestError - This is typically used to create HTTP response failure errors, for example the server responds with a 400 Bad Request code
• com.ebasetech.xi.services.HttpAuthorisationError - This should be used when generating Authentication errors, for example the server responds with a 401 Unauthorized code
• com.ebasetech.xi.services.HttpNotFoundError - This should be used when generating not found errors, for example the server responds with a 404 Not Found code
• com.ebasetech.xi.services.HttpServerError - This should be used when generating generic server errors, for example the server responds with a 500 Server Error code
• com.ebasetech.xi.services.HttpUnknownError - This should be used when generating an unknown or unrecognized error, for example the HTTP code is not recognized

Further documentation.

JavaScript example:

 // call Users REST API
 function callUsersAPI()
 {
   var response = services.rest.get("http://example.com/rest/users");
   if(!response.isSuccess()) {
     switch(response.code) {
       case 401:
          // Send an email stating that the service is authorized
          fields.unauthorizedError.value = response.body;
          resources.sysAdmin.sendMail();
          throw services.errors.createAuthorisationError("Unauthorized", response.code);
       
       default:
          throw services.errors.createRequestError("Request error", response.code);
   }
   //process result
 }