<back to all web services
POSModifierGroups
POS Management Module - Enquiry
POS Modifier Group API
Requires Authentication
| Required permission: | POSModifierGroupList-Enquiry.GET |
The following routes are available for this service:| 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 | |
|---|
POSModifierGroups Parameters:| 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 |
POSModifierGroupsResponse Parameters:| 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. |
POSModifierGroup Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ModifierGroup | form | AcPOSModifierGroupCompany | No | |
| ModifierGroupItem | form | List<AcPOSModifierGroupCompanyItem> | No | |
AcPOSModifierGroupCompany Parameters:| 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 |
AcPOSModifierGroupCompanyItem Parameters:| 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 .xml suffix or ?format=xml
HTTP + XML
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<POSModifierGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
<POSModifierGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
<d2p1:POSModifierGroup>
<d2p1:ModifierGroup>
<d2p1:AcPOSModifierGroupCompanyID>String</d2p1:AcPOSModifierGroupCompanyID>
<d2p1:AcPOSModifierGroupDesc>String</d2p1:AcPOSModifierGroupDesc>
<d2p1:AcPOSModifierGroupID>String</d2p1:AcPOSModifierGroupID>
</d2p1:ModifierGroup>
<d2p1:ModifierGroupItem>
<d2p1:AcPOSModifierGroupCompanyItem>
<d2p1:AcPOSModifierGroupCompanyItemID>String</d2p1:AcPOSModifierGroupCompanyItemID>
<d2p1:AcPOSModifierGroupDesc>String</d2p1:AcPOSModifierGroupDesc>
<d2p1:AcPOSModifierGroupID>String</d2p1:AcPOSModifierGroupID>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
<d2p1:ImageDisplayBase64>String</d2p1:ImageDisplayBase64>
<d2p1:ModifierItemDesc>String</d2p1:ModifierItemDesc>
<d2p1:ModifierItemIsStock>String</d2p1:ModifierItemIsStock>
<d2p1:ModifierItemPrice>0</d2p1:ModifierItemPrice>
<d2p1:StockBarcode>String</d2p1:StockBarcode>
<d2p1:StockDescription1>String</d2p1:StockDescription1>
<d2p1:StockDescription2>String</d2p1:StockDescription2>
</d2p1:AcPOSModifierGroupCompanyItem>
</d2p1:ModifierGroupItem>
</d2p1:POSModifierGroup>
</POSModifierGroups>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<TotalRecords>0</TotalRecords>
<TotalRecordsInPage>0</TotalRecordsInPage>
</POSModifierGroupsResponse>