Versions Compared

Key

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

...

In order to use the API endpoints, the endpoints must be accessible to the third party system; allowing such access will be handled by the lab’s IT department or resource, to ensure compatibility with the local IT security requirements. Note that Rx-API does support SSL - if used, the lab’s IT department or resource will need to provide and keep updated the appropriate certificate to allow access via SSL.

Request order information via flat file

Similar to how there are two methods to submit orders to Rx-Universe (flat file and endpoint), there are two methods to request status of order(s) that are in Rx-Universe.

The third-party system can submit a flat file requesting the status of an order, using the _ACTION=3 tag. The options are described fully in the Remote Order Entry section, but in brief, to request the status of order 12345678, you can submit a file containing:

JOB=12345678
_ACTION=3

In response, Rx-Universe will create a file in a designated folder containing the current status of the job at the lab. Again, this is described in the same section. Retrieving the status file from Rx-Universe can be done via local folder or ftp, per the lab’s IT department or resource.

Request order information via API endpoint

Requesting information on an order is best done using the API endpoints. There are several endpoints that return information about an order; the equivalent to _ACTION=3 above would be the /orders/status endpoints. This endpoint accepts one value, the order number for which to return job status, and will return the status of the order; a sample response is:
{ "order-number": "119136", "order-status": "P", "unvalid-message": "", "order-status-station": "GEN", "order-status-desc": "GEN-LOH GENERATOR", "order-status-cust-desc": "IN SURFACING", "order-status-date": "20220921", "order-status-time": "1529" }