| Required permission: | POSModifierGroupList-Enquiry.GET |
| GET | /POSModifierGroups | ||
|---|---|---|---|
| GET | /POSModifierGroups/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /POSModifierGroups/AcPOSModifierGroupID/{AcPOSModifierGroupID} | Get record for given POS Modifier Group ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| AcPOSModifierGroupID | path | string | No | POS Modifier Group ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| POSModifierGroups | form | List<POSModifierGroup> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ModifierGroup | form | AcPOSModifierGroupCompany | No | |
| ModifierGroupItem | form | List<AcPOSModifierGroupCompanyItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcPOSModifierGroupCompanyID | form | NVARCHAR(40) | No | POS Modifier Group Record ID |
| AcPOSModifierGroupID | form | NVARCHAR(20) | No | POS Modifier Group ID |
| AcPOSModifierGroupDesc | form | NVARCHAR(100) | No | POS Modifier Group Description |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcPOSModifierGroupCompanyItemID | form | NVARCHAR(40) | No | POS Modifier Group Item Record ID |
| AcPOSModifierGroupID | form | NVARCHAR(20) | No | POS Modifier Group ID |
| StockBarcode | form | NVARCHAR(20) | No | Stock Barcode |
| ModifierItemIsStock | form | NVARCHAR(1) | No | Modifier Item is Stock? Y/N |
| ModifierItemDesc | form | NVARCHAR(100) | No | Modifier Item Description |
| ModifierItemPrice | form | NUMERIC(18,2) | No | Modifier Item Price |
| AcPOSModifierGroupDesc | form | NVARCHAR(100) | No | POS Modifier Group Description |
| AcStockID | form | NVARCHAR(20) | No | Stock ID. |
| AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID. |
| StockDescription1 | form | NVARCHAR(100) | No | Stock Desription 1. |
| StockDescription2 | form | NVARCHAR(100) | No | Stock Desription 2. |
| ImageDisplayBase64 | form | VARCHAR(MAX) | No | Stock Display Image in Base64 Encoding. |
| EditDate | form | DATETIME | No | Edit Date Item |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /POSModifierGroups HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
POSModifierGroups:
[
{
ModifierGroup:
{
AcPOSModifierGroupCompanyID: String,
AcPOSModifierGroupID: String,
AcPOSModifierGroupDesc: String
},
ModifierGroupItem:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
TotalRecords: 0,
TotalRecordsInPage: 0
}