Error Handling

• Description
• Forward Compatibility Errors(1xx)
• Connection Errors(2xx)
• Backward Compatibility Errors(3xx)
• Web Server Response Codes And Messages(4xx)
• Internal Errors(5xx)
• Sample Error Codes

Description

Macy's API - is "adapter" of Macys.com to remote clients. So there is we can distinguish 6 stages of using Macy's API and so 6 places of errors:

• client can not establish connection to Macy's API
• Macy's API can not adapt request to Macys.com
• Macy's API can not establish connection to Macys.com
• Macy's API can not adapt Macys.com response to client
• Macys.com reply error response to Macy's API
• Macy's API internal errors

First stage can not be processed by Macy's API so remains 5 types of errors returned from Macy's API. Error codes divided in 5 diapasones:

• 100-199 Forward Compatibility Errors(1xx) - These errors are created as a result of a impossibility of translating client request to Macys API request: can not map request, incorrect arguments, etc.
• 200-299 Connection Errors(2xx) - These errors are created as a result of a connection failing to be established to a Macys.com server. They will contain a brief description of why a connection could not be established. This class of errors contains "full stack" connections errors: TCP connection, HTTP request/responce, Hessian RPC-call. Also this class of errors contains all stages of connection establishing, using, closing, timeouting, etc. 
• 300-399 Backward Compatibility Errors(3xx) - Macys sent correct response(in business-logic sence) to Gateway but Gateway can't convert to correct JSON.
•  400-499 Web Server Response Codes And Messages(4xx) - call to Macys returned correct erorr message so we translate (perhaps with some transformations).
•  500-599. Internal Errors(5xx) - Some error during processing request or general error-state of gateway or low resources for processing - no threads in pools, low free memory, etc.

In every diapasone first error code(100, 200, 300, 400, 500) has "General" sence. So in test/development/production mode we can return only 5 not specialized codes.

Detailed description

1. Forward Compatibility Errors(1xx)

2. Connection Errors(2xx)

This class of errors contains "full stack" connections errors: TCP connection, HTTP request/responce, Hessian RPC-call. Also this class of errors contains all stages of connection establishing, using, closing, timeouting, etc.

3. Backward Compatibility Errors(3xx)

4. Web Server Response Codes And Messages(4xx)

5. Internal Errors(5xx)

6. REST Framework

7. converter.util

8. store.service

9. store.provider

10. catalog.service(FCC)

Sample Errored Request and Response

Sample Request 1

URL:

 http://api.macys.com/v1/catalog/reviews?productId=7758

HTTP Header:

x-macys-webservice-client-id: 123456789 (The API key is wrong in this case.  It should be xmj9js4jkdpe1983fmwu98gh not 123456789.  You will also get this response if your keys are not activated. Please reach out to apisupport@macys.com if you are having trouble getting your key approved)

Accept: application/json

Http Status: 403 Forbidden

Response:

{Developer Inactive}

Sample Request 2

URL:

 http://api.macys.com/v1/catalog/reviews?productId=7758 (The URL in this case is trying to hit a v1 service that does not exist.  It should be v3 not v1)

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Http Status: 404 Not Found

Response:

{errorCode: 101
message:"There is no mapping for request"
-errorDetail: [1]
0: "<a href="http://services2.macys.com/resources/v1/catalog/reviews?productId=7758" _mce_href="http://services2.macys.com/resources/v1/catalog/reviews?productId=7758" title="Click to insert into URL field">http://services2.macys.com/resources/v1/catalog/reviews?productId=7758</a>"
success:false}

back to top