Versions Compared

Key

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

...

Property

Description

orderNumber

string

The identifier for the order

trayNumber

string

The tray number the order is attached to

poNumber

string

Job reference (PO NUM field)

calculationDesc

string

The current calculation status of the order (for humans)

  • Both eyes calculated

  • Right eye calculated

  • Left eye calculated

  • Calculations not done

currentStation

string

The current status/station for the order

currentStationCustomerDesc

string

The current customer status description for the order

currentStationDateTime

string|null

The date and time the current status was applied to the order in format yyyy-mm-ddThh:mm:ss.fffZ (ISO 8601) or null

currentStationDesc

string

The current status/station description for the order

status

string

The current status of the order (U = Unvalid, V = Valid, P = Process, C = Complete, W = Hold)

statusDesc

string

The current status of the order (for humans)

  • Unvalid

  • Valid

  • Process

  • Completed

  • On Hold

  • Other

onHold

boolean

Whether or not the order is on hold

unvalidMessage

string

The reason why the order was last set unvalid (if any)

rtCalculated

boolean

Whether or not calculations have been done for the right eye

ltCalculated

boolean

Whether or not calculations have been done for the right eye

...

Code Block
{
  "error": "No record found",
  "details": [
    "Provided: 999999"
  ]
}

If the requested order has been marked for cancellation an HTTP 200 error code will be returned with the standard error body.

Code Block
languagejson
{
  "error": "Order marked for cancelation",
  "details": []
}