This app command allows users to add and edit notes of a transaction. Each note is assigned a note id which is generated by Oliver by concatenating users' app id and a randomized integer.
GET
Description:
Retrieves notes from Oliver.
Request Body:
JSON
{
command: 'Notes',
method: 'get',
version: '1.0',
note_id: '',
title: 'Discount',
description: 'Black Friday Sale'
}Response Body:
JSON
{
command: 'Notes',
method: 'get',
version: '1.0',
status_code: 200,
error: null,
data: {
{
title: 'Discount',
description: 'Black Friday Sale',
amount: 5.00,
outlet: 'Village Mall'
},
{
title: 'Discount',
description: 'Black Friday Sale',
amount: 42.20,
outlet: 'Avalon Mall'
},
{
title: 'Discount',
description: 'Black Friday Sale',
amount: 13.25, outlet: 'Mount Pearl' }
}
}Parameters:
Attribute Name | Attribute Type | Description | Required (binary) |
command | string | High level command name to interact with Oliver | 1 |
method | string | These correspond to create, read, update, and delete (or CRUD) operations | 1 |
version | string | The version of the command used | 1 |
note_id | string | Unique identifier for a note | 0 |
title | string | Title of the note | 0 |
description | string | Description of the note | 0 |
PUT
Description:
Modify existing notes in Oliver
Request Body:
JSON
{
command: ‘Notes’,
method: ‘put’,
version: ‘1.0’,
note_id: ‘oli12201’,
title: ‘’, description: ‘One semester parking fee, parking lot D’
}Response Body:
JSON
{
command: 'Notes',
method: 'put',
version: '1.0',
status_code: 200
data: {
note_id: 'oli12201',
title: 'Parking Pass',
description: 'One semester parking fee, parking lot D' }
}
Parameters:
Attribute Name | Attribute Type | Description | Required (binary) |
command | string | High level command name to interact with Oliver | 1 |
method | string | These correspond to create, read, update, and delete (or CRUD) operations | 1 |
version | string | The version of the command used | 1 |
note_id | string | Unique identifier for a note | 0 |
title | string | Title of the note | 0 |
description | string | Description of the note | 0 |
POST
Description:
Create notes in Oliver
Request Body:
JSON
{
command: 'Notes',
method: 'post',
version: '1.0',
title: 'Gift Card',
description: '$100 cash voucher'
}Response Body:
JSON
{
command: 'Notes',
method: 'post',
version: '1.0',
status_code: 200,
note_id: 'oli11523'
}Remarks: note_id is generated by Oliver [appID + integer]
Parameters:
Attribute Name | Attribute Type | Description | Required (binary) |
command | string | High level command name to interact with Oliver | 1 |
method | string | These correspond to create, read, update, and delete (or CRUD) operations | 1 |
version | string | The version of the command used | 1 |
title | string | Title of the note | 0 |
description | string | Description of the note | 0 |