An optional add-on which can be added to an item ordered from a lab catalog.
| Property | Description |
|---|---|
| addOnGroup |
The type of add-on for which the option is one possible choice. |
| description |
Display text shown to the user in order to give them information concerning the option. |
| displayName |
The name of the add-on option to be used when displaying the option to a user. |
| id |
The identifier for the lab catalog add-on option. |
| label |
The name of the option as defined and used externally by the lab. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| optionId nullable |
An external ID of the add-on option as defined in the lab's catalog. |
| retailPrice |
A decimal value of the retail price of the add-on option. |
| type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "An optional add-on which can be added to an item ordered from a lab\ncatalog.",
"properties": {
"addOnGroup": {
"description": "The type of add-on for which the option is one possible choice.",
"type": "string"
},
"description": {
"description": "Display text shown to the user in order to give them information\nconcerning the option.",
"type": "string"
},
"displayName": {
"description": "The name of the add-on option to be used when displaying the option\nto a user.",
"type": "string"
},
"id": {
"description": "The identifier for the lab catalog add-on option.",
"type": "integer"
},
"label": {
"description": "The name of the option as defined and used externally by the lab.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"optionId": {
"description": "An external ID of the add-on option as defined in the lab's catalog.",
"nullable": true,
"type": "string"
},
"retailPrice": {
"description": "A decimal value of the retail price of the add-on option.",
"type": "number"
},
"type": {
"description": "The type of object represented.",
"enum": [
"lab-catalog-add-on-option"
],
"type": "string"
}
},
"title": "Lab Catalog Add-on Option",
"type": "object"
}