Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


The

...

The default port for Rx-Universe API calls is 4567, but this can be changed (show how) 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://localhost:4567/api/get_orderstatus?order=2340894

The following APIs are available for use by laboratories.

Order Data

get_orderstatus - Status of an order - get_orderstatus?order=2340894

get_hotjobs- Get list of hot jobs - get_hotjobs

get_orderinfo  - Get Rx and other information on a specific order - get_orderinfo?order=12345678

get_wipbreakdown - get a breakdown of orders in process - get_wip-breakdown (no arguments)

Job Tracking Data

get_wip - gets the WIP numbers real-time, no arguments - http://localhost:4567/api/get_wip

get_wipbydate  - gets the WIP numbers for a period of time; takes 4 parameters (start date, start time, end date, end time) - http://localhost:4567/api/get_wipbydate?startdate=20190416&starttime=08000000&enddate=20190416&endtime=23590000

get_wip30days  - gets the WIP numbers (in, completed, transferred, canceled, and wip) by date for the past 30 calendar days - http://localhost:4567/api/get_wip30days
                              optionally accepts a starting date from which to count backwards - for example, to start from 27 January 2019, use - http://localhost:4567/api/get_wip30days?input=20190127

create_jobtrack - allows third-party system to request update of job tracking information for an order in Rx-Universe - http://localhost:4567/api/create_jobtrack?order=2341296&station=001

get_jtstations - gets a list of all job tracking stations set up in Rx-Universe (excluding conveyor decision points) - http://localhost:4567/api/get_jtstations 

Inventory Data

get_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_breakage - method has one optional argument, returns a list of all breakage for the date specified, totals and by reason

do_lenspick - method accepts the order number and OPCs for right and left lens, to do lens pick verification


get_posbydate - method accepts a date, and returns a list of purchase orders created on that datePlease see each individual section in this group for information on specific methods available for laboratories to use.