Environment

This app command allows users to retrieve the environment variables such as the register id, register location, user credentials.

GET

Description:
Retrieve register id, print size, location data and employee data.

Request Body:

{
    command: 'Environment', 
    method: 'get',
    version: '1.0'
}

Response Body:

{
    command: 'Environment',
    method: 'get',
    version: '1.0',
    status_code: 200,
    error: null,
    register_id: 2,
    print_size: '58mm',
    location_data:{
        location_id: 005521, 
        outlet: 'Village Mall' 
    },
    employee_data: {
        admin_id: 1111220, 
        designation: 'cashier' 
    }
}

Parameters:

Attribute Name

Attribute Type

Description

Enum

Required (binary)

command

string

High level command name to interact with Oliver

null

1

method

string

These correspond to create, read, update, and delete (or CRUD) operations

null

1

version

string

The version of the command used

null

1


Did this page help you?