Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

This endpoint allows an external system to POST lens breakages against an Rx-Universe Rx order.

Inputs:

order - Rx-Universe order number
right breakage code - the code for the right breakage, up to 7 characters are allowed

right employee code - the 2 character code for the employee reporting the breakage

left breakage code - the code for the left breakage, up to 7 characters are allowed

left employee code - the 2 character code for the employee reporting the breakage

rtDept - if sub-codes are being used in Rx-Universe, the department is required and must exist in the department table

ltDept - if sub-codes are being used in Rx-Universe, the department is required and must exist in the department table

rtPosition - if sub-codes are being used in Rx-Universe, the position is required and must exist in the position table

ltPosition - if sub-codes are being used in Rx-Universe, the position is required and must exist in the position table

rtShift - if sub-codes are being used in Rx-Universe, the shift is optional, but if specified it must exist in the shift table.

ltShift - if sub-codes are being used in Rx-Universe, the shift is optional, but if specified it must exist in the shift table.

reverse_breakage_flag - When set to “Y”, the endpoint will reverse the breakage specified by the entries above.

Response:

The response indicates the status of the breakage request.

If the breakage was done, “successful” is returned.

{
  "order-number": "xxxxxxxx",
  "status": "00",
  "message": "Successful"
}

If the submission cannot be processed, the response will indicate the reason why. Possible reasons for not processing are as follows:

status = message

  • 1 = order not found - the specified Rx Order does not exist

  • 2 = order deleted - the specified Rx order has been flagged for deletion

  • 3 = order unvalid - the specified Rx Order has not been validated

  • 4 = order already completed - the specified Rx order has already been completed

  • 5 = order entered is a stock order - the specified Rx order is a stock type order not an Rx order

  • 10 = breakage requires sub-fields - the RxUniverse system requires the use of breakage sub-codes, breakages cannot be carried out with this function.

  • 11 = no breakage entered - no breakage codes have been jsupplied

  • 12 = Right employee with no right breakage - a right employee code is present with no right breakage code

  • 13 = Left employee with no left breakage - a left employee code is present with no left breakage code

  • 14 = a sub-code was entered but sub-codes are not active in Rx-Universe

  • 15 = the specified department code does not exist in Rx-Universe

  • 16 = the specified shift code does not exist in Rx-Universe

  • 17 = the specified position code does not exist in Rx-Universe

  • 18 = department code is required when using sub-codes

  • 19 = position is required when using sub-codes

  • 20 = no lens right eye - the specified Rx order has no right lens to break

  • 21 = no lens left eye - the specified Rx order has no left lens to break

  • 22 = invalid breakage code right eye - the breakage code for the right eye does not appear in the breakage reason database

  • 23 = invalid breakage code left eye - the breakage code for the left eye does not appear in the breakage reason database

  • 24 = invalid breakage code both eyes - the breakage codes for both eyes do not appear in the breakage reason database

  • 25 = invalid employee code right eye - the employee code for the right eye is required

  • 26 = invalid employee code left eye - the breakage code for the left eye is required

  • 27 = invalid employee code both eyes - the breakage codes for both eyes are required

  • 28 = No breakage to reverse - there are no breakages reported on the order

  • No labels