Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Next »

GET /api/v2/addons/{code}

This endpoint is used to retrieve comprehensive data on a single registered addon code.

image-20240112-123543.png

Accepts

  • An addon code, which must be the unique identifying code for the addon

    • image-20240112-124032.png

      This addon can be retrieved using SRC. Case matters (src will not retrieve a record).

Returns

Success

A JSON object representing the requested addon

Property

Description

code

string

The unique code identifying the addon

desc

string

The text description for the addon

excludeFromRxSite

boolean

Whether or not the addon should be excluded from Rx-Site

externalCode

string|null

The value of of the _EXTERNALCODE VCA override, if set (otherwise null)

isAR

boolean

Whether or not the addon is anti reflective

isBackside

boolean

Whether or not the addon is backside

isMirror

boolean

Whether or not the addon is a mirror coat

isTint

boolean

Whether or not the addon is a tint

isUV

boolean

Whether or not the addon is UV

requiresDropBall

boolean

Whether or not the addon requires drop ball

requiresEtching

boolean

Whether or not the addon requires etching

requiresHarden

boolean

Whether or not the addon requires hardening

requiresPolish

boolean

Whether or not the addon requires polish

Error

If the code parameter does not match an addon for any order in the system an HTTP 404 code will be returned with the standard error body

{
  "error": "No record found",
  "details": [
    "Provided: 999999"
  ]
}
  • No labels