Revel 2.79 Revel API changelog
Welcome to the 2.79 Revel API changelog!
In an effort to make the Modifier related API calls more performant, we have added a query string parameter to remove printer detail. When the user sets the query string parameter to false, they will no longer get the printer details which will significantly reduce the payload size of the response.
These API modifications were made to /resources/Modifier/ and /resources/Modifier/{id}:
A new optional query string parameter, expand_printers has been added.
Query String Parameter name: expand_printers
Value type : boolean as string (case-insensitive)
Default value: True (if not passed in or invalid value set)
Description: If the query string parameter is set to false then the printers field in the response will be an array of URIs rather than an array of JSON objects. The response will include printers value as an array of JSON objects when: value set to true, no recognized value set, no value set, field not passed in the call
Endpoints that use this parameter:
This query string parameter allows integrated partners to reduce payload size of the response for the printers.
The query string parameter will have a string value of a boolean, it will default to true.
Examples of responses based on parameter value:
Query String Parameter Passed in as False (casing doesn't matter)
{
"sort": 1,
"conv_ordering_disp": true,
"kds_tags": [
],
"kitchen_print_name": null,
"cost": "0.0000",
"created_by": "/enterprise/User/7/",
"is_conditional_mod": false,
"id": 103192,
"description": "",
"sku": "",
"uuid": "18c42e88-a319-42de-a48f-4611b5befd07",
"is_quick": false,
"updated_by": "/enterprise/User/2830/",
"substitutions": [
],
"display_in_kiosk": true,
"do_not_print": false,
"printers": [
"/resources/Device/615/",
"/resources/Device/616/",
"/resources/Device/2215/"
],
"substitute_modifiers": false,
"img_url": null,
"updated_date": "2023-11-16T11:20:32.282978",
"color_code": 0,
"deleted": false,
"price": 0.0,
"barcode": "100000003275",
"modifierClass": "/resources/ModifierClass/27294/",
"active": true,
"name": "Buffalo",
"kitchen_description": "",
"display_online": true,
"prep_recipe": false,
"third_party_name": "",
"establishment": "/enterprise/Establishment/160/",
"no_modifier_substitute": false,
"prep_yield": null,
"created_date": "2022-05-19T07:41:23.648726",
"is_hot": false,
"conv_ordering_sort_order": null,
"track_recipe": false,
"resource_uri": "/resources/Modifier/103192/"
}
Query String Parameter Passed in as True or not passed in at all (casing doesn't matter)
{
"sort": 1,
"conv_ordering_disp": true,
"kds_tags": [
],
"kitchen_print_name": null,
"cost": "0.0000",
"created_by": "/enterprise/User/7/",
"is_conditional_mod": false,
"id": 103192,
"description": "",
"sku": "",
"uuid": "18c42e88-a319-42de-a48f-4611b5befd07",
"is_quick": false,
"updated_by": "/enterprise/User/2830/",
"substitutions": [
],
"display_in_kiosk": true,
"do_not_print": false,
"printers": [
{
"user_pswd": null,
"scale_measurement_unit": 0,
"swipe_type": 0,
"bumpbar_type": 0,
"print_coordinator": null,
"third_party_id": "",
"printer_language": null,
"device_type": 1,
"printer_type": 18,
"barcode_scanner_type": null,
"printer_encoding": "pc858",
"port": null,
"model_num": null,
"printer_pos_or_items": 1,
"uuid": "1b5695c6-1a3b-41df-8429-d31e65b986a5",
"platform": "",
"id": 615,
"os_version": null,
"printer_delegate": null,
"version": null,
"establishment": "/enterprise/Establishment/102/",
"printer_expo": false,
"label_template": null,
"printer_cash_drawer_signal_type": "LOW",
"kitchen_printer_chime": false,
"printer_model": 15,
"deviceextraparameters": [
],
"mac": "...",
"printer_template": null,
"rfid_reader_type": 0,
"fire_course_template": null,
"active": true,
"ip_address": null,
"scale_type": 0,
"name": "U220-1",
"printer_render_mode": null,
"user_code": null,
"kitchen_flow_views": [
],
"void_receipt_template": null,
"bumpbar_orientation": 0,
"gift_receipt_template": null,
"resource_uri": "/resources/Device/615/"
},
{
"user_pswd": null,
"scale_measurement_unit": 0,
"swipe_type": 0,
"bumpbar_type": 0,
"print_coordinator": null,
"third_party_id": "",
"printer_language": null,
"device_type": 1,
"printer_type": 18,
"barcode_scanner_type": null,
"printer_encoding": "pc858",
"port": null,
"model_num": null,
"printer_pos_or_items": 1,
"uuid": "14eccb3b-3ccf-4d6a-b25a-a31e3dbea3a3",
"platform": "",
"id": 616,
"os_version": null,
"printer_delegate": null,
"version": null,
"establishment": "/enterprise/Establishment/102/",
"printer_expo": false,
"label_template": null,
"printer_cash_drawer_signal_type": "LOW",
"kitchen_printer_chime": false,
"printer_model": 15,
"deviceextraparameters": [
],
"mac": "...",
"printer_template": null,
"rfid_reader_type": 0,
"fire_course_template": null,
"active": true,
"ip_address": null,
"scale_type": 0,
"name": "U220-2",
"printer_render_mode": null,
"user_code": null,
"kitchen_flow_views": [
],
"void_receipt_template": null,
"bumpbar_orientation": 0,
"gift_receipt_template": null,
"resource_uri": "/resources/Device/616/"
},
{
"user_pswd": null,
"scale_measurement_unit": 0,
"swipe_type": 0,
"bumpbar_type": 0,
"print_coordinator": null,
"third_party_id": "",
"printer_language": null,
"device_type": 1,
"printer_type": 18,
"barcode_scanner_type": null,
"printer_encoding": "pc858",
"port": null,
"model_num": null,
"printer_pos_or_items": 1,
"uuid": "4fca807e-1f50-4c1c-8111-244e8a288479",
"platform": "",
"id": 125,
"os_version": null,
"printer_delegate": null,
"version": null,
"establishment": "/enterprise/Establishment/27/",
"printer_expo": false,
"label_template": null,
"printer_cash_drawer_signal_type": "LOW",
"kitchen_printer_chime": false,
"printer_model": 15,
"deviceextraparameters": [
],
"mac": "",
"printer_template": "/resources/PosTemplate/274/",
"rfid_reader_type": 0,
"fire_course_template": null,
"active": true,
"ip_address": null,
"scale_type": 0,
"name": "U220-1",
"printer_render_mode": null,
"user_code": null,
"kitchen_flow_views": [
],
"void_receipt_template": null,
"bumpbar_orientation": 0,
"gift_receipt_template": null,
"resource_uri": "/resources/Device/125/"
},
],
"substitute_modifiers": false,
"img_url": null,
"updated_date": "2023-11-16T11:20:32.282978",
"color_code": 0,
"deleted": false,
"price": 0.0,
"barcode": "100000003275",
"modifierClass": "/resources/ModifierClass/27294/",
"active": true,
"name": "Buffalo",
"kitchen_description": "",
"display_online": true,
"prep_recipe": false,
"third_party_name": "",
"establishment": "/enterprise/Establishment/160/",
"no_modifier_substitute": false,
"prep_yield": null,
"created_date": "2022-05-19T07:41:23.648726",
"is_hot": false,
"conv_ordering_sort_order": null,
"track_recipe": false,
"resource_uri": "/resources/Modifier/103192/"
}