SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » ErrorResponse Call Reference
Trace: • ErrorResponse Call Reference
developer_guide:error-handling-guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer_guide:error-handling-guide [2009/08/08 03:43] – created mattdeveloper_guide:error-handling-guide [2009/08/08 03:48] (current) – matt
Line 1: Line 1:
 ====== ErrorResponse Call Reference ====== ====== ErrorResponse Call Reference ======
  
-You will receive an error response XML document when a request has a complete failure.  For example, if a "SubscriptionRequest" is sent to the incorrect EndPoint (or address) then the service will not know how to response.  The service will issue you a "500 HTTP Status Code" indicating a server error.  Your application will detect the 500 HTTP Status Code and proceed to check for ErrorResponse.  You will not always receive an error response. However, if an error response exists it will be helpful for debugging purposes.+ 
 + 
 +You will receive an error response XML document when a request has a complete failure.  For example, if a "SubscriptionRequest" is sent to the incorrect EndPoint (or address) then the service will not know how to response.  The service will issue you a 500 [[:developer_guide:developer_guide#http-status-code|HTTP Status Code]] indicating a server error.  Your application will detect the 500 [[:developer_guide:developer_guide#http-status-code|HTTP Status Code]] and proceed to check for ErrorResponse.  You will not always receive an error response. However, if an error response exists it will be helpful for debugging purposes. 
 + 
 + 
  
  
 ===== ErrorResponse ===== ===== ErrorResponse =====
 +
 +
  
 ==== Overview ==== ==== Overview ====
 +
 +
  
 The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box. The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box.
 +
 +
  
 ==== XML ==== ==== XML ====
 +
 <code> <code>
 +
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
 +
     <ErrorResponse>      <ErrorResponse>
 +
         <ErrorCode>string</ErrorCode>         <ErrorCode>string</ErrorCode>
 +
         <Timestamp>timestamp</Timestamp>          <Timestamp>timestamp</Timestamp>
 +
     </ErrorResponse>"     </ErrorResponse>"
 +
 </code> </code>
 +
 +
  
 ==== Elements ==== ==== Elements ====
 +
 +
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
 +
 | ErrorResponse | container | required | Parent Element | | ErrorResponse | container | required | Parent Element |
 +
 | ErrorCode | string | always | The code of the error.  You can look up error codes in the developer's guide. | | ErrorCode | string | always | The code of the error.  You can look up error codes in the developer's guide. |
 +
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
 +
  
developer_guide/error-handling-guide.1249717400.txt.gz · Last modified: 2009/08/16 00:00 (external edit)