This endpoint allows an order to be submitted to Rx-Universe from another system, as an alternative to submitting an order as a flat file (in GIF format, for example - described elsewhere).
The endpoint is described in swagger; the initial release allows specifying all of the core information required for an order. Some personalization options are not currently available, and will be added at a future date, based on customer requests. In addition, a submitted order can request a particular shape or stored trace, but cannot submit trace data directly. Again, this can be added at a future date based on customer request.
The input is shown below, and the options are more fully described in the Model section of this endpoint in Swagger. Following this description are some sample inputs of different types of jobs:
{
"customerNum": "string",
"custJobID": "string",
"poNumber": "string",
"releaseNumber": "string",
"dateWanted": "string",
"jobType": "string",
"labHoldOrder": "string",
"tray": "string",
"shipMethod": "string",
"shipToNum": "string",
"shipToName": "string",
"shipToAddress1": "string",
"shipToAddress2": "string",
"shipToAddress3": "string",
"shipToAddress4": "string",
"shipToCode": "string",
"rtLensStyle": "string",
"ltLensStyle": "string",
"rtLensMaterial": "string",
"ltLensMaterial": "string",
"rtLensColor": "string",
"ltLensColor": "string",
"rtLensTreat": "string",
"ltLensTreat": "string",
"rtSPH": 0,
"ltSPH": 0,
"rtCYL": 0,
"ltCYL": 0,
"rtAX": 0,
"ltAX": 0,
"rtIPD": 0,
"ltIPD": 0,
"rtNPD": 0,
"ltNPD": 0,
"rtOCHT": 0,
"ltOCHT": 0,
"rtBCOCUP": 0,
"ltBCOCUP": 0,
"rtSEGHT": 0,
"ltSEGHT": 0,
"rtADD": 0,
"ltADD": 0,
"rtADD2": 0,
"ltADD2": 0,
"rtBOC": 0,
"ltBOC": 0,
"rtMBASE": "string",
"ltMBASE": "string",
"rtCLASS": "string",
"ltCLASS": "string",
"rtDIA": "string",
"ltDIA": "string",
"rtPRVM1": 0,
"rtPRVA1": "string",
"rtPRVM2": 0,
"rtPRVA2": "string",
"ltPRVM1": 0,
"ltPRVA1": "string",
"ltPRVM2": 0,
"ltPRVA2": "string",
"rtMINCTR": 0,
"ltMINCTR": 0,
"rtMINEDG": 0,
"ltMINEDG": 0,
"rtNVI": 0,
"ltNVI": 0,
"rtNOD": 0,
"ltNOD": 0,
"rtERCD": 0,
"ltERCD": 0,
"rtBalance": "string",
"ltBalance": "string",
"rtFWD": 0,
"ltFWD": 0,
"addon1": "string",
"addon2": "string",
"addon3": "string",
"addon4": "string",
"addon5": "string",
"addon6": "string",
"addon7": "string",
"addon8": "string",
"addon9": "string",
"addon10": "string",
"addon11": "string",
"addon12": "string",
"addon13": "string",
"addon14": "string",
"addon15": "string",
"misc1_SKU": "string",
"misc1_Desc": "string",
"misc2_SKU": "string",
"misc2_Desc": "string",
"REM": "string",
"PTOK": "string",
"CLLIFE": "string",
"CLNVB": "string",
"CLINIT": "string",
"CLHT": "string",
"HEADK": "string",
"HEADS": "string",
"NWD": "string",
"CAPE": "string",
"_FSTATUS": "string",
"FUPC": "string",
"_FMUPC": "string",
"_FMSKU": "string",
"FRAM": "string",
"FCOL": "string",
"PANTO": "string",
"ZTILT": "string",
"VFD": "string",
"VRD": "string",
"CORRLEN": "string",
"CLDEYE": "string",
"CLDLAT": "string",
"CRIB": 0,
"HBOX": 0,
"VBOX": 0,
"ELLH": 0,
"FED": 0,
"DBL": 0,
"CIRC": 0,
"_ETYPE": "string",
"ORIGIN": "string",
"traceID": "string"
}
Notes
Note that information not required for an order need not be sent - in this case, because the order is an uncut, there is no need to send any frame information (size or shape request); since it is a SV lens, there is no need to send SEGHT, ADD, or other tags related to the near segment.
The lens style, material, tint and treatment codes that are sent much be the codes that are used in Rx-Universe. Similarly, any addon codes sent must exist in Rx-Universe.
If an order is successfully received (there are no validation issues), an order number is assigned and returned to the calling program:
{ "orderNumber": "102345" }
If an order fails validation for any reason, an appropriate error message is returned; for example, if a bifocal (ST28) is submitted, but the add power is omitted, appropriate error(s) will be returned:
{ "error12:": "373: Add power must be greater than 0",
"error45:": "373: Add power must be greater than 0"
}
Sample Orders
Uncut with no frame measurements:
{
"customerNum": "1",
"custJobID": "API DEMO 1",
"poNumber": "123456",
"releaseNumber": "123456",
"jobType": "D",
"shipToName": "SHP PLACE",
"shipToAddress1": "123 SHIP AVE",
"shipToAddress2": "SUITE 100",
"shipToAddress3": "SHIPSVILLE",
"shipToAddress4": "NV",
"shipToCode": "12345",
"rtLensStyle": "SV",
"ltLensStyle": "SV",
"rtLensMaterial": "P",
"ltLensMaterial": "P",
"rtSPH": -1.00,
"ltSPH": -1.00,
"rtCYL": -0.50,
"ltCYL": -0.75,
"rtAX": 115,
"ltAX": 85,
"addon1": "ARC",
"CRIB": 65,
"ORIGIN": "3RD PARTY"
}
Full job - Poly IDEAL Transitions 8 Gray with ARC and box measurements
{
"customerNum": "1",
"custJobID": "API DEMO 2",
"poNumber": "23456",
"releaseNumber": "23456",
"jobType": "F",
"rtLensStyle": "IDEAL",
"ltLensStyle": "IDEAL",
"rtLensMaterial": "C",
"ltLensMaterial": "C",
"rtLensColor": "GY3",
"ltLensColor": "GY3",
"rtLensTreat": "TR8",
"ltLensTreat": "TR8",
"rtSPH": 1.25,
"ltSPH": 1.00,
"rtCYL": -0.50,
"ltCYL": -0.75,
"rtAX": 85,
"ltAX": 115,
"rtIPD": 31,
"ltIPD": 30.5,
"rtSEGHT": 23,
"ltSEGHT": 23,
"rtADD": 2.50,
"ltADD": 2.50,
"addon1": "ARC",
"HBOX": 53,
"VBOX": 48,
"FED": 55,
"DBL": 14,
"_ETYPE": "Z",
"ORIGIN": "3RD PARTY"
}
Full job flat top 28 with stored trace (shape) and Rx prism of 1D In in each eye:
{
"customerNum": "1",
"custJobID": "API DEMO 4",
"poNumber": "23458",
"releaseNumber": "23458",
"jobType": "F",
"rtLensStyle": "ST28",
"ltLensStyle": "ST28",
"rtLensMaterial": "C",
"ltLensMaterial": "C",
"rtLensColor": "",
"ltLensColor": "",
"rtLensTreat": "SRC",
"ltLensTreat": "SRC",
"rtSPH": 1.25,
"ltSPH": 1.00,
"rtCYL": -0.50,
"ltCYL": -0.75,
"rtAX": 85,
"ltAX": 115,
"rtIPD": 31,
"ltIPD": 30.5,
"rtNPD": 29.5,
"ltNPD": 29.0,
"rtSEGHT": 19,
"ltSEGHT": 19,
"rtADD": 2,
"ltADD": 2,
"rtPRVM1": 1.00,
"rtPRVA1": "In",
"ltPRVM1": 1.00,
"ltPRVA1": "In",
"HBOX": 53,
"VBOX": 48,
"FED": 55,
"DBL": 14,
"_ETYPE": "Z",
"ORIGIN": "3RD PARTY",
"traceID": "RB3025;LUX;;57;14"
}