appStatus

This app command sends a message to the parent window, indicating whether an app has successfully been executed and completed its task, or has failed. This command will allow OliverPOS to wait for certain apps to complete their task before proceeding.

POST

Description:
Notify Oliver that ‘655536ninetwentyfive’ app has completed its execution.

Request Body:

{
    command: 'appStatus',
    method: 'post',
    version: '1.0',
    appID: '655536ninetwentyfive',
    appStatus: 'complete'
}

Response Body:

{
    command: 'appStatus',
    method: 'post',
    version: '1.0',
    status: 200,
    error: null
}

Parameters:

Attribute NameAttribute TypeDescriptionEnumRequired (binary)
commandstringHigh level command name to interact with Olivernull1
methodstringThese correspond to create, read, update, and delete (or CRUD) operationsnull1
versionstringThe version of the command usednull1
appIDstringUnique Identifier issued by Oliver to applications in Oliver App storenull1
appStatusstringCurrent working status of the application‘running, ‘complete’, ‘fail’1

Did this page help you?