The Rx-API module is expected to be available in fall 2019. Documentation is included here for beta testing purposes.
The default port for Rx-Universe API calls is 4567, but this can be changed by setting PORT in the .env and restarting the service. The destination URL should be made up of the server hosting the API calls (usually the Rx-Universe server), plus the port number, and the name of the API method, in the format:
http://server:port/api/method?methodargument=value
For example:
http://localhost:4567/api/get_orderstatus?order=2340894
The following APIs are available for use by laboratories.
Order Data
Get Order Status (/orders/status) - Status of an order
Get Hot Jobs (/jobs/hot) - Get list of hot jobs
Get Late Jobs (/jobs/late) - Get list of late jobs
Get Order Info (/orders) - Get Rx and other information on a specific order
Order Tracking History - Get tracking history for a specific order
Job Tracking Data
Get WIP (/wip) - gets the WIP numbers real-time, no arguments
Get WIP Breakdown (/wip/breakdown) - get a breakdown of orders in process
Get WIP by Date (/wip/date) - gets the WIP numbers for a period of time; takes 4 parameters (start date, start time, end date, end time)
Get Historical WIP (/wip/30days) - gets the WIP numbers (in, completed, transferred, canceled, and wip) by date for the past 30 calendar days
optionally accepts a starting date from which to count backwards
Create Job Track (/jt/checkin) - allows third-party system to request update of job tracking information for an order in Rx-Universe
Get JT Stations (/jt/stations) - gets a list of all job tracking stations set up in Rx-Universe (excluding conveyor decision points)
Get Job Counts at Stations (/jt/stations/jobs/count) - gets a list of all job tracking stations set up in Rx-Universe as well as how many jobs are currently at that station
Get Jobs at Station (/jt/stations/jobs) - gets a list of all jobs at a given station
Inventory Data
Get Inventory (/inventory) - if called with no arguments, returns a list of all active lenses; optionally accepts one argument which is either the stock number or OPC of a single item
Get Breakages (/breakages) -method has one optional argument, returns a list of all breakage for the date specified, totals and by reason
Lens Pick (/lenses/pick) - method accepts the order number and OPCs for right and left lens, to do lens pick verification
Get Purchase Orders (/pos/date) - method accepts a date, and returns a list of purchase orders created on that date
Get Purchase Order (/pos/num) - method accepts a date, and returns a list of purchase orders created on that date
Get Breakage Codes (/breakages/codes) - method has no inputs, and returns a list of breakage reason codes. Note, lab must be using the option to prompt for valid reasons only (on the Orders2 tab in System Settings).
Update Inventory by OPC (/inventory/update/opc) - a POST method that updates an inventory item's shelf, bin, cost, min, and/or max.
Receivings (/lenses/receivings) - input is either a date in yyyymmdd format, or a purchase order number. All receivings for that date or PO number are returned.
Employee Data
Get Employees (/employees) - returns a list of all employees in RxUniverse