User Tools

Site Tools


7. Error Handling

If the resource path cannot be resolved, the server will return a standard HTTP status code of 404, “Not Found”.

Parameter errors, along with some server side errors are signalled via the success parameter of the replyStatus group being set to false. An error code and textual description are provided via the error parameters errorCode and errorMsg, also in the replyStatus group in the reply.

Error code ranges

  • 1xx Request string errors
  • 2xx Server errors
Error Code Parameter Error Message Logic
100 ndc Invalid `ndc` parameter, does not conform to any known format. error=(given ndc can not be decoded)
101 matchPackSize Invalid `matchPackSize` parameter. Valid boolean values: true, false. error=(!=true or false)
102 id Invalid `id` parameter. error=(0 or non numeric chars)
103 rxcui Invalid `rxcui` parameter error=(0 or non numeric chars)
104 shape Invalid `shape` parameter. Valid shapes are: BULLET, CAPSULE, CLOVER, DIAMOND, DOUBLE CIRCLE, FREEFORM, GEAR, HEPTAGON, HEXAGON, OCTAGON, OVAL, PENTAGON, RECTANGLE, ROUND, SEMI-CIRCLE, SQUARE, TEAR, TRAPEZOID, TRIANGLE.
105 color Invalid `color` parameter. Valid colors are: BLACK, GRAY, WHITE, RED, PURPLE, PINK, GREEN, YELLOW, ORANGE, BROWN, BLUE, TURQUOISE. error=(!= valid color, see parameter def)
106 colorRgb Invalid `colorRgb` parameter.
107 colorRgbT Invalid `colorRgbT` parameter.
108 symbol Invalid `symbol` parameter. Valid boolean values: true, false. error=(!=true or false)
109 size Invalid `size` parameter. error=(0 or non numeric chars)
110 sizeT Invalid `sizeT` parameter. error=(non numeric chars)
111 score Invalid `score` parameter. error=(non numeric chars)
112 imprintColor Invalid `imprintColor` parameter. Valid colors are: BLACK, GRAY, WHITE, RED, PURPLE, PINK, GREEN, YELLOW, ORANGE, BROWN, BLUE, TURQUOISE. error=(!= valid color, see parameter def)
113 imprintType Invalid `imprintType` parameter. Valid imprint types are: DEBOSSED, EMBOSSED, PRINTED. error=(!= valid type, see parameter def)
114 imprint Invalid `imprint` parameter. error=(empty string)
150 rLimit Invalid `rLimit` parameter. error=(0 or non numeric chars)
151 rPageSize Invalid `rPageSize` parameter. error=(0 or non numeric chars)
152 rPage Invalid `rPage` parameter. error=(0, non numeric chars or > max possible pages)
153 resolution Invalid `resolution` parameter. Valid resolutions are: 120, 300, 600, 800, 1024, full. error=(unsupported resolution, see parameter def)
200 Server unable to complete request, please try again later.

Page Tools