...
The input is shown below, and the options are more fully described in the Model section of this endpoint in Swagger. Following this full 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.
...
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, an 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:
{
"customercustomerNum": "1",
"patientcustJobID": "API 20210607-DEMO 1",
"jobpoNumber": "123456",
"releaseNumber": "API 20210607-1123456",
"jobType": "D",
"shipToName": "SHIP SHP PLACE",
"shipToAddress1": "123 SHIP AVE",
"shipToAddress2": "SUITE 100",
"shipToAddress3": "SHIPSVILLE",
"shipToAddress4": "ONNV",
"shipToPostalCodeshipToCode": "123 45612345",
"rtLensStyle": "SV",
"ltLensStyle": "SV",
"rtLensMaterial": "P",
"ltLensMaterial": "P",
"rtSpherertSPH": -1.000,
"ltSphereltSPH": -1.000,
"rtCylinderrtCYL": -0.50,
"ltCylinderltCYL": -0.75,
"rtAxisrtAX": 85115,
"ltAxisltAX": 11585,
"uncutDiamaddon1": 65
}Full job - progressive with box measurements{
"customer": "1"ARC",
"patientCRIB": "API-TEST-6"65,
"jobORIGIN": "API-TEST-6",
"jobType": "F",
"tray": "",
"shipToName": "",
"shipToAddress1": "3RD PARTY"
}
Full job - Poly IDEAL Transitions 8 Gray with ARC and box measurements
{
"customerNum": "1",
"shipToAddress2custJobID": "API DEMO 2",
"shipToAddress3poNumber": "23456",
"shipToAddress4releaseNumber": "23456",
"shipToPostalCodejobType": "F",
"rtLensStyle": "IDEAL",
"ltLensStyle": "IDEAL",
"rtLensMaterial": "C",
"ltLensMaterial": "C",
"rtLensColor": "GY3",
"ltLensColor": "GY3",
"rtLensTreat": "TR8",
"ltLensTreat": "TR8",
"rtSpherertSPH": 1.25,
"ltSphereltSPH": 1.00,
"rtCylinderrtCYL": -0.50,
"ltCylinderltCYL": -0.75,
"rtAxisrtAX": 85,
"ltAxisltAX": 115,
"rtDistPDrtIPD": 31,
"ltDistPDltIPD": 3130.5,
"rtNearPDrtSEGHT": 023,
"ltNearPDltSEGHT": 023,
"rtVertDecrtADD": 02.50,
"ltVertDecltADD": 02.50,
"rtSeghtaddon1": 23"ARC",
"ltSeghtHBOX": 2353,
"rtAddVBOX": 248,
"ltAddFED": 255,
"rtBOCDBL": 014,
"ltBOC_ETYPE": 0,
"rtHPrism": 1,
"rtHPrismDir": "In"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",
"rtVPrismpoNumber": 1"23458",
"rtVPrismDirreleaseNumber": "Up23458",
"ltHPrismjobType": 1"F",
"ltHPrismDirrtLensStyle": "InST28",
"ltVPrismltLensStyle": 1.25"ST28",
"ltVPrismDirrtLensMaterial": "DownC",
"addon1ltLensMaterial": "ARCC",
"addon2rtLensColor": "PE",
"addon3ltLensColor": "",
"addon4rtLensTreat": "SRC",
"addon5ltLensTreat": "SRC",
"addon6rtSPH": 1.25,
"ltSPH": 1.00,
"addon7rtCYL": -0.50,
"ltCYL": -0.75,
"addon8rtAX": 85,
"ltAX": 115,
"addon9rtIPD": 31,
"ltIPD": 30.5,
"addon10rtNPD": 29.5,
"ltNPD": 29.0,
"addon11rtSEGHT": 19,
"ltSEGHT": 19,
"addon12rtADD": 2,
"ltADD": 2,
"addon13": "" "rtPRVM1": 1.00,
"rtPRVA1": "In",
"ltPRVM1": 1.00,
"addon14ltPRVA1": "In",
"addon15HBOX": ""53,
"uncutDiamVBOX": 048,
"frameAFED": 5255,
"frameBDBL": 4214,
"frameED_ETYPE": 53"Z",
"frameDBLORIGIN": 14"3RD PARTY",
"storedTracetraceID": "RB3025;LUX;;57;14"
}