com.sgapi.services

Class IntegrationImport

java.lang.Object

com.sgapi.services.IntegrationImport

public class IntegrationImport
extends java.lang.Object

With a path of integrate/import this module handles the importing of data into the SG v5 System. When data already exists, it is updated. Each object has it's own unique keys which must be specified in order to persist the data. If an inner object is not present, it will be created, however if the inner object does exist, it will not be updated by the incoming inner object data. To update inner objects in this instance, use the direct method for updating that object rather than one where it is referenced. Each method will return saved instances of data plus a response code. 200 = OK, 404 will provide an exception.

Author:

SGSystems

Target Uri:

/integrate/import

Constructor Summary

Constructors

Constructor and Description
IntegrationImport()

Method Summary

Modifier and Type	Method and Description
Transfer	postTransfers(java.lang.String referenceNumber, java.lang.String newReferenceNumber, java.lang.String externalID) Update ReferenceNumber.
javax.ws.rs.core.Response	setAddress(java.util.List<Address> addresses) Imports a list of addresses.
javax.ws.rs.core.Response	setAllergen(java.util.List<Allergen> allergens) Imports a list of allergens that can be used in the system.
javax.ws.rs.core.Response	setAllergenLink(java.util.List<AllergenLink> allergenLinks) Imports a list of links between allergens and commodities.
javax.ws.rs.core.Response	setAnswer(java.util.List<Answer> answers) Imports a list of answers which can be associated to Questions.
javax.ws.rs.core.Response	setBulkPlatform(java.util.List<BulkPlatform> bulkPlatforms) Import bulk dispense systems.
javax.ws.rs.core.Response	setClient(java.util.List<Client> clients) Imports a client record A Client can be a Supplier or a Customer See Client for details
javax.ws.rs.core.Response	setCommodity(java.util.List<Commodity> commodities) Import a list of commodities/ingredients for use in formulas.
javax.ws.rs.core.Response	setCommodityGroup(java.util.List<CommodityGroup> commodityGroups) Imports a commodity group.
javax.ws.rs.core.Response	setCommodityGroupLink(java.util.List<CommodityGroupLink> commodityGroupLinks) Imports commodity group links.
javax.ws.rs.core.Response	setContainer(java.util.List<Container> containers) Imports a list of containers for use in the system.
javax.ws.rs.core.Response	setContainerLink(java.util.List<ContainerLink> containerLinks) Imports a list of links between Containers and stock.
javax.ws.rs.core.Response	setCustomField(java.util.List<CustomField> customFields) Imports a custom field for use on labels.
javax.ws.rs.core.Response	setCustomFieldLink(java.util.List<CustomFieldLink> customFieldLinks) As with @setCustomField, This allows for the linkage to occur between a given commodity/formula to a particular custom field which has been predefined for printing on the label.
javax.ws.rs.core.Response	setDeletePurchaseOrder(PurchaseOrder purchaseOrder)
javax.ws.rs.core.Response	setDeleteSalesOrder(SalesOrder salesOrder)
javax.ws.rs.core.Response	setDeleteTransfer(java.lang.String referenceNumber) Delete a transfer record See Transfer
javax.ws.rs.core.Response	setFormula(java.util.List<Formula> formulas) Import formulas/recipes with or without formula steps.
javax.ws.rs.core.Response	setFormulaStep(java.util.List<FormulaStep> formulaSteps) Imports the steps of a formula.
javax.ws.rs.core.Response	setHazard(java.util.List<Hazard> hazards) Imports a list of hazards for use in prompting operators during system operation.
javax.ws.rs.core.Response	setHazardLink(java.util.List<HazardLink> hazardLinks) Imports the linkage between Hazards and Commodities.
javax.ws.rs.core.Response	setJob(java.util.List<Job> jobs) Imports jobs for the production plan.
javax.ws.rs.core.Response	setLabelFormatSet(java.util.List<LabelFormatSet> labelFormatSets) Imports label format sets.
javax.ws.rs.core.Response	setLabelFormatSetLink(java.util.List<LabelFormatSetLink> labelFormatSetLinks) Imports the link between label format sets and label format types with associated label data.
javax.ws.rs.core.Response	setLabelFormatType(java.util.List<LabelFormatType> labelFormatTypes) Imports a list of label format types.
javax.ws.rs.core.Response	setLabelPrinterType(java.util.List<LabelPrinterType> labelPrinterTypes) Imports a label printer type.
javax.ws.rs.core.Response	setLocation(java.util.List<Location> locations) Imports a list of physical locations.
javax.ws.rs.core.Response	setModifyPreBatch(java.util.List<PreBatch> preBatches)
javax.ws.rs.core.Response	setModifyPurchaseOrder(java.util.List<PurchaseOrder> purchaseOrders) Imports purchase orders.
javax.ws.rs.core.Response	setModifySalesOrder(java.util.List<SalesOrder> salesOrders) Imports sales orders.
javax.ws.rs.core.Response	setOrderInformation(java.util.List<OrderInformation> orderInformations) Imports order information for use in purchase orders and sales orders.
javax.ws.rs.core.Response	setPreBatch(java.util.List<PreBatch> preBatches) Used for importing specific batch sizes rather than using the job import This URI will allow for the third party to schedule batches in a specific manner rather than allowing the V5 system to use it's logic to schedule the individual batch sizes within a job See PreBatch for details
javax.ws.rs.core.Response	setPurchaseOrder(java.util.List<PurchaseOrder> purchaseOrders) Imports purchase orders.
javax.ws.rs.core.Response	setPurchaseOrderLine(java.util.List<PurchaseOrderLine> purchaseOrderLines) Allows for the importing of purchase order lines.
javax.ws.rs.core.Response	setQALink(java.util.List<QALink> qaLinks) Imports a list of links between Questions/Messages and the events which triggers them.
javax.ws.rs.core.Response	setReturnPurchaseOrder(java.lang.String lotNumber, java.lang.String commodityCode, java.lang.Double quantity)
javax.ws.rs.core.Response	setReturnSalesOrder(java.lang.String saleOrder, java.lang.String lotNumber, java.lang.Double quantity)
javax.ws.rs.core.Response	setSalesOrder(java.util.List<SalesOrder> salesOrders) Imports sales orders.
javax.ws.rs.core.Response	setSalesOrderLine(java.util.List<SalesOrderLine> salesOrderLines) Allows for the importing of sales order lines.
javax.ws.rs.core.Response	setSalesOrderLineCustomField(java.util.List<SalesOrderLineCustomField> salesOrderLineCustomFields) Imports a list of sales order line custom field headers.
javax.ws.rs.core.Response	setSalesOrderLineCustomFieldLink(java.util.List<SalesOrderLineCustomFieldLink> salesOrderLineCustomFieldLinks) This method allows for the linkage of sales order lines to custom sales order fields for specific label printing instructions on a per sales order line basis.
javax.ws.rs.core.Response	setSite(java.util.List<Site> sites) Imports a header grouping for a list of locations.
javax.ws.rs.core.Response	setSiteSupplier(java.util.List<SiteSupplier> siteSuppliers) Imports a list of links between sites and clients (suppliers).
javax.ws.rs.core.Response	setSiteSupplierCommodity(java.util.List<SiteSupplierCommodity> siteSupplierCommodities) Imports a list of links between Sites and Supplier Commodities.
javax.ws.rs.core.Response	setStock(java.util.List<Stock> stock) Imports a stock header record.
javax.ws.rs.core.Response	setStockAdjust(StockAdjustment stockAdjustment)
javax.ws.rs.core.Response	setStockLocation(java.util.List<StockLocation> stockLocations) Imports a stock detail record.
javax.ws.rs.core.Response	setSupplierCommodity(java.util.List<SupplierCommodity> supplierCommodities) Imports a list of links between suppliers and commodities.
javax.ws.rs.core.Response	setSupplierCommodityContainer(java.util.List<SupplierCommodityContainer> supplierCommodityContainers) Imports a list of containers which are associated with a particular set of @setSupplierCommodity Supplier Commodity pairings.
javax.ws.rs.core.Response	setTerminal(java.util.List<Terminal> terminals) Import terminals with name and configuration.
javax.ws.rs.core.Response	setTerminalLocation(java.util.List<TerminalLocation> terminalLocations) Import a list of terminal location pairs.
javax.ws.rs.core.Response	setTransfer(java.util.List<Transfer> transfers) Imports a list of system transfer headers.
javax.ws.rs.core.Response	setTransferLine(java.util.List<TransferLine> transferLines) Imports a list of transfer lines.
javax.ws.rs.core.Response	setUnit(java.util.List<WeightUnit> units) Imports a list of WeighUnits.
javax.ws.rs.core.Response	setUnitCommodity(java.util.List<UnitCommodity> unitCommodities) Imports a list of units with associated commodities.
javax.ws.rs.core.Response	setUser(java.util.List<User> users) Imports operator profiles which use the system.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntegrationImport

public IntegrationImport()

Method Detail

setPurchaseOrder

public javax.ws.rs.core.Response setPurchaseOrder(java.util.List<PurchaseOrder> purchaseOrders)

Imports purchase orders. You can specify a list of purchase order lines within the object or you can just import the header data. See PurchaseOrder

Parameters:

purchaseOrders - The list of purchase orders to be imported

Returns:

Returns saved purchase order instances complete with IDs and response code

Target Uri:

/purchase

Request Type:

POST

setPurchaseOrderLine

public javax.ws.rs.core.Response setPurchaseOrderLine(java.util.List<PurchaseOrderLine> purchaseOrderLines)

Allows for the importing of purchase order lines. Lines may be imported separately to a header and the header can be referenced from the line, however the header cannot be modified when importing a line. For header alteration use PurchaseOrder. A purchase order header must be defined and referenced prior to importing/modifying a line. See PurchaseOrderLine

Parameters:

purchaseOrderLines - A list of purchase order lines for importing

Returns:

Returns a list of saved purchase order lines with response code.

Target Uri:

/purchase_line

Request Type:

POST

setSalesOrder

public javax.ws.rs.core.Response setSalesOrder(java.util.List<SalesOrder> salesOrders)

Imports sales orders. You can specify a list of sales order lines within the object or you can just import the header data. See SalesOrder

Parameters:

salesOrders - The list of sales orders to be imported

Returns:

Returns saved sales order instances complete with ID and response code

Target Uri:

/sales

Request Type:

POST

setSalesOrderLine

public javax.ws.rs.core.Response setSalesOrderLine(java.util.List<SalesOrderLine> salesOrderLines)

Allows for the importing of sales order lines. Lines may be imported separately to a header and the header can be referenced from the line, however the header cannot be modified when importing a line. For header alteration use SalesOrder. A sales order header must be defined and referenced prior to importing/modifying a line. See SalesOrderLine

Parameters:

salesOrderLines - A list of sales order lines for importing

Returns:

Returns a list of saved sales order lines with response code.

Target Uri:

/sales_line

Request Type:

POST

setFormula

public javax.ws.rs.core.Response setFormula(java.util.List<Formula> formulas)

Import formulas/recipes with or without formula steps. Formula steps can be created and modified along with the formula header via this import. See Formula

Parameters:

formulas - A list of formulas for import

Returns:

returns a list of saved formulas with response code

Target Uri:

/formula

Request Type:

POST

setJob

public javax.ws.rs.core.Response setJob(java.util.List<Job> jobs)

Imports jobs for the production plan. Typically would contain a formula and quantity to be scheduled at a minimum. See Job

Parameters:

jobs - List of jobs for importing

Returns:

Saved jobs with ID's and response code

Target Uri:

/job

Request Type:

POST

setCommodity

public javax.ws.rs.core.Response setCommodity(java.util.List<Commodity> commodities)

Import a list of commodities/ingredients for use in formulas. See Commodity

Parameters:

commodities - A list of commodities to import

Returns:

A list of saved commodities with response code

Target Uri:

/commodity

Request Type:

POST

setSupplierCommodity

public javax.ws.rs.core.Response setSupplierCommodity(java.util.List<SupplierCommodity> supplierCommodities)

Imports a list of links between suppliers and commodities. This assigns a link between which suppliers provide which commodities. The list is many to many so a client can provide multiple suppliers which provide the same commodity and conversely, a supplier can provide multiple commodities. This aids with raising Purchase Orders in the SG V5 System. See SupplierCommodity

Parameters:

supplierCommodities - A list of links between suppliers and commodities

Returns:

The saved list of links with respone code

Target Uri:

/supplier_commodity

Request Type:

POST

setSupplierCommodityContainer

public javax.ws.rs.core.Response setSupplierCommodityContainer(java.util.List<SupplierCommodityContainer> supplierCommodityContainers)

Imports a list of containers which are associated with a particular set of @setSupplierCommodity Supplier Commodity pairings. This allows for the assignment of containers/pallets/bins for use in tracking or performing scale tares, to a commodity that is linked to a supplier. For example, Supplier A provides Good X in Container Y. setSupplierCommodity can be ignored if containers are also imported alongside supplier commodity pairings. See SupplierCommodityContainer

Parameters:

supplierCommodityContainers - A list of supplier commodity container links

Returns:

A saved list of supplier commodity container links with ID's and response code

Target Uri:

/supplier_commodity_container

Request Type:

POST

setTerminal

public javax.ws.rs.core.Response setTerminal(java.util.List<Terminal> terminals)

Import terminals with name and configuration. This can be a Terminal or WMS instance. Terminals are automatically created if they do not exist so pre-assigning terminals is not necessarily required. See Terminal

Parameters:

terminals - Terminals for import

Returns:

Returns a list of saved terminals with response code

Target Uri:

/terminal

Request Type:

POST

setTerminalLocation

public javax.ws.rs.core.Response setTerminalLocation(java.util.List<TerminalLocation> terminalLocations)

Import a list of terminal location pairs. This assigns stock or production locations to a terminals visible range of inventory or jobs respectively. See TerminalLocation

Parameters:

terminalLocations - A list of terminal-location pairs. For example, Terminal 1 - Location A, Terminal 1 - Location B.

Returns:

returns a list of saved terminal locations complete with response code

Target Uri:

/terminal_location

Request Type:

POST

setCustomField

public javax.ws.rs.core.Response setCustomField(java.util.List<CustomField> customFields)

Imports a custom field for use on labels. This can be used for tagging data which is outside of the standard data provisions. For example, a storage temperate may want to be printed on a label, this can be linked via importing a custom field. For example STORAGE_TEMP could be provided as the label parameter and using @setCustomFieldLink, a storage temperate for a given commodity could be stored for use when printing that particular label. See CustomField

Parameters:

customFields - A list of custom field headers for import

Returns:

A saved list of custom headers

Target Uri:

/custom_field

Request Type:

POST

setCustomFieldLink

public javax.ws.rs.core.Response setCustomFieldLink(java.util.List<CustomFieldLink> customFieldLinks)

As with @setCustomField, This allows for the linkage to occur between a given commodity/formula to a particular custom field which has been predefined for printing on the label. See CustomFieldLink

Parameters:

customFieldLinks - A list of links between a custom field name and a commodity code

Returns:

A list of saved custom field links with response code

Target Uri:

/custom_field_link

Request Type:

POST

setCommodityGroup

public javax.ws.rs.core.Response setCommodityGroup(java.util.List<CommodityGroup> commodityGroups)

Imports a commodity group. A commodity group is an umbrella association between commodities. For example; banana, strawberry, apple could all be assigned to a group called Fruit. This method imports the commodity group header. See @setCommodityGroupLink for importing links This aids with reporting and other facilities within the system. See CommodityGroup

Parameters:

commodityGroups - A list of commodity group headers for importing

Returns:

A list of saved commodity groups with response code

Target Uri:

/commodity_group

Request Type:

POST

setCommodityGroupLink

public javax.ws.rs.core.Response setCommodityGroupLink(java.util.List<CommodityGroupLink> commodityGroupLinks)

Imports commodity group links. See @setCommodityGroup(). This allows for the linkage between commodity groups and commodities. This can be used in place of commodity group for initial creation. Any non-existant commodity groups will be created. See CommodityGroupLink

Parameters:

commodityGroupLinks - A list of commodity group links for importing

Returns:

A saved list of commodity groups with response code

Target Uri:

/commodity_group_link

Request Type:

POST

setBulkPlatform

public javax.ws.rs.core.Response setBulkPlatform(java.util.List<BulkPlatform> bulkPlatforms)

Import bulk dispense systems. Minimum requirements are a name, IP and port. Needs to be configured to communicate with the SG V5 System to work. See BulkPlatform

Parameters:

bulkPlatforms - A list of bulk platforms for import

Returns:

A list of saved bulk dispense systems.

Target Uri:

/bulk_platform

Request Type:

POST

setHazard

public javax.ws.rs.core.Response setHazard(java.util.List<Hazard> hazards)

Imports a list of hazards for use in prompting operators during system operation. This is header data and can be used to identify events during production such as 'Wear a Mask', 'Wear Eye Glasses'. See Hazard

Parameters:

hazards - A list of hazards for import

Returns:

A list of saved hazards with resposne code

Target Uri:

/hazard

Request Type:

POST

setHazardLink

public javax.ws.rs.core.Response setHazardLink(java.util.List<HazardLink> hazardLinks)

Imports the linkage between Hazards and Commodities. Which commodities require which hazard warnings to appear. A many-to-many relationship. See HazardLink

Parameters:

hazardLinks - A list of hazards with associated commodity links

Returns:

A saved list of hazard links with response code

Target Uri:

/hazard_link

Request Type:

POST

setUnitCommodity

public javax.ws.rs.core.Response setUnitCommodity(java.util.List<UnitCommodity> unitCommodities)

Imports a list of units with associated commodities. Conversion values are specified as a numeric division of the base system unit. For example, if the system uses LB as the base unit, the value specified should be how many gallons in an LB. This method allows for specific definition of conversion rates for particular commodities. For example, a gallon of water and a gallon of oil would have a different conversion rate to LB. If no conversion is specified here, the default conversion in the WeightUnit table is used. See UnitCommodity

Parameters:

unitCommodities - A list of units with associated specific commodity links

Returns:

A saved list of unit commodities with response code

Target Uri:

/unit_commodity

Request Type:

POST

setSalesOrderLineCustomField

public javax.ws.rs.core.Response setSalesOrderLineCustomField(java.util.List<SalesOrderLineCustomField> salesOrderLineCustomFields)

Imports a list of sales order line custom field headers. Similar to custom_field, this allows for the placement of sales order specific information onto shipping labels and reports. See SalesOrderLineCustomField

Parameters:

salesOrderLineCustomFields - A list of sales order line custom fields links for saving

Returns:

A saved list of sales order line custom field links with response code

Target Uri:

/sales_line_custom_field

Request Type:

POST

setSalesOrderLineCustomFieldLink

public javax.ws.rs.core.Response setSalesOrderLineCustomFieldLink(java.util.List<SalesOrderLineCustomFieldLink> salesOrderLineCustomFieldLinks)

This method allows for the linkage of sales order lines to custom sales order fields for specific label printing instructions on a per sales order line basis. For example a header may be specified as FRAGILE and want to be printed on the label. Here, we can define which sales order lines require the fragile sticker and which don't. See SalesOrderLineCustomFieldLink

Parameters:

salesOrderLineCustomFieldLinks - A list of sales order line custom field links for import

Returns:

A list of saved sales order line custom field links with response code

Target Uri:

/sales_line_custom_field_link

Request Type:

POST

setQALink

public javax.ws.rs.core.Response setQALink(java.util.List<QALink> qaLinks)

Imports a list of links between Questions/Messages and the events which triggers them. See the list of events that can be assigned. This can also be paired with a commodity. For example, On stock receipt of Commodity X, show this message. You can use the question import to import headers See QALink

Parameters:

qaLinks - A list of links between questions, events and commodities with specified parameters

Returns:

A saved list of QAlinks with response code

Target Uri:

/qa_link

Request Type:

POST

setTransfer

public javax.ws.rs.core.Response setTransfer(java.util.List<Transfer> transfers)

Imports a list of system transfer headers. A transfer represents a movement of stock from one part of the organization to another. For example, stock transfer between warehouses. See Transfer

Parameters:

transfers - A list of transfer headers to be imported

Returns:

A list of saved transfer headers with response code

Target Uri:

/transfer

Request Type:

POST

postTransfers

public Transfer postTransfers(java.lang.String referenceNumber,
                              java.lang.String newReferenceNumber,
                              java.lang.String externalID)

Update ReferenceNumber. A transfer represents a movement of stock from one part of the organization to another. For example, stock transfer between warehouses. See Transfer

Parameters:

referenceNumber - The transfer order reference number and the new referenceNumber

Returns:

The transfer order object

Target Uri:

/transfer

Request Type:

POST

setTransferLine

public javax.ws.rs.core.Response setTransferLine(java.util.List<TransferLine> transferLines)

Imports a list of transfer lines. Transfer lines specify which commodities need to be transferred and the quantity of that transfer along with a link to the transfer header. See TransferLine

Parameters:

transferLines - A list of transfer lines, for example Commodity A 50LB, Facility B, Transfer Order # 1234.

Returns:

A saved list of transfer orders with response code

Target Uri:

/transfer_line

Request Type:

POST

setDeleteTransfer

public javax.ws.rs.core.Response setDeleteTransfer(java.lang.String referenceNumber)

Delete a transfer record See Transfer

Parameters:

referenceNumber - The transfer order reference number

Returns:

Response

Target Uri:

/transfer/{referenceNumber}

Request Type:

POST

setSite

public javax.ws.rs.core.Response setSite(java.util.List<Site> sites)

Imports a header grouping for a list of locations. Stock and production locations can be associated with a Site header to group these locations. This can be used for separating facility A from facility B when reporting or performing other functions within the system. The link exists in the location object. It's a one-to-many link. See Site

Parameters:

sites - A list of sites for import

Returns:

A saved list of sites with reponse code

Target Uri:

/site

Request Type:

POST

setSiteSupplier

public javax.ws.rs.core.Response setSiteSupplier(java.util.List<SiteSupplier> siteSuppliers)

Imports a list of links between sites and clients (suppliers). This allows for the linkage of clients to sites which means that terminals on each site will not See suppliers for other sites. Facility A may receive sugar from Supplier B while Facility B may receive sugar from Supplier C. This aids with searching for suppliers when creating purchase orders. See SiteSupplier

Parameters:

siteSuppliers - A list of site supplier links

Returns:

A saved list of site suppliers along with a response code

Target Uri:

/site_supplier

Request Type:

POST

setSiteSupplierCommodity

public javax.ws.rs.core.Response setSiteSupplierCommodity(java.util.List<SiteSupplierCommodity> siteSupplierCommodities)

Imports a list of links between Sites and Supplier Commodities. This takes setSiteSupplier(List) to the next level by linking these Supplier/Site pairs with Commodities. This works in the same way as setSupplierCommodity(List) but in a site specific manner. See SiteSupplierCommodity

Parameters:

siteSupplierCommodities - A list of site_supplier and commodities pairs.

Returns:

A saved list of SiteSupplierCommodities

Target Uri:

/site_supplier_commodity

Request Type:

POST

setOrderInformation

public javax.ws.rs.core.Response setOrderInformation(java.util.List<OrderInformation> orderInformations)

Imports order information for use in purchase orders and sales orders. This can be printed on labels, reports, prompted, etc. See OrderInformation

Parameters:

orderInformations - A list of order information for use with orders

Returns:

A list of saved order information complete with response code

Target Uri:

/order_information

Request Type:

POST

setLocation

public javax.ws.rs.core.Response setLocation(java.util.List<Location> locations)

Imports a list of physical locations. Locations can be stock locations or production locations and can be assigned to a terminal. See Location

Parameters:

locations - A list of locations to import

Returns:

A list of saved locations with response code

Target Uri:

/location

Request Type:

POST

setUnit

public javax.ws.rs.core.Response setUnit(java.util.List<WeightUnit> units)

Imports a list of WeighUnits. These can be used throughout the system to determine the unit of many quantity fields. Primarily, a commodity must have a default stocking unit. See WeightUnit

Parameters:

units - A list of units

Returns:

A list of saved units with response code

Target Uri:

/unit

Request Type:

POST

setAddress

public javax.ws.rs.core.Response setAddress(java.util.List<Address> addresses)

Imports a list of addresses. These can be assigned to clients. This is where goods can be shipped to or received from. See Address

Parameters:

addresses - A list of addresses linked to clients

Returns:

A saved list of addresses with response code

Target Uri:

/address

Request Type:

POST

setAllergenLink

public javax.ws.rs.core.Response setAllergenLink(java.util.List<AllergenLink> allergenLinks)

Imports a list of links between allergens and commodities. This can be used in the same manner as setHazardLink(List). It allows for the assignment of allergens to particular commodities in a many-to-many link. See AllergenLink

Parameters:

allergenLinks - A list of allergens paired with associated commodities

Returns:

Returns a saved list of allergen links with response code

Target Uri:

/allergen_link

Request Type:

POST

setAllergen

public javax.ws.rs.core.Response setAllergen(java.util.List<Allergen> allergens)

Imports a list of allergens that can be used in the system. Allergens can be assigned to commodities with setAllergenLink(List) See Allergen

Parameters:

allergens - A list of allergens to be used

Returns:

A list of saved Allergens with response code

Target Uri:

/allergen

Request Type:

POST

setAnswer

public javax.ws.rs.core.Response setAnswer(java.util.List<Answer> answers)

Imports a list of answers which can be associated to Questions. See Answer

Parameters:

answers - A list of possible answers to Questions

Returns:

A saved list of Answers with response code

Target Uri:

/answer

Request Type:

POST

setFormulaStep

public javax.ws.rs.core.Response setFormulaStep(java.util.List<FormulaStep> formulaSteps)

Imports the steps of a formula. This can be used if the formula header already exists. setFormula(List) can be used to import the header and the lines, this method can be used to just update lines. See FormulaStep

Parameters:

formulaSteps - A list of formulasteps to update

Returns:

A list of saved formula steps and response code

Target Uri:

/formula_step

Request Type:

POST

setUser

public javax.ws.rs.core.Response setUser(java.util.List<User> users)

Imports operator profiles which use the system. Providing a username and various options you can create users with this method. See User

Parameters:

users - A list of users to import

Returns:

A list of saved users plus response code

Target Uri:

/user

Request Type:

POST

setContainer

public javax.ws.rs.core.Response setContainer(java.util.List<Container> containers)

Imports a list of containers for use in the system. See the container object for possible types. Can be used to represent any type of container, pallet, tub, carton, etc See Container

Parameters:

containers - A list of containers to import

Returns:

A list of saved containers with response code

Target Uri:

/container

Request Type:

POST

setContainerLink

public javax.ws.rs.core.Response setContainerLink(java.util.List<ContainerLink> containerLinks)

Imports a list of links between Containers and stock. This is used to represent stock in storage units. For example, 50LB of mushrooms in tub B or 5000LB of flour on Pallet X. Check Container for list of types. See ContainerLink

Parameters:

containerLinks - A list of containerLinks for import

Returns:

A saved list of container links

Target Uri:

/container_link

Request Type:

POST

setLabelFormatType

public javax.ws.rs.core.Response setLabelFormatType(java.util.List<LabelFormatType> labelFormatTypes)

Imports a list of label format types. Label format types are specific labels which can be printed in the system. For example STOCK, BATCH, PRODUCT, etc. These rarely need altering and will be setup by the vendor. See LabelFormatType

Parameters:

labelFormatTypes - A list of label format types to import

Returns:

A saved list of label format types with response code

Target Uri:

/label_format_type

Request Type:

POST

setLabelFormatSet

public javax.ws.rs.core.Response setLabelFormatSet(java.util.List<LabelFormatSet> labelFormatSets)

Imports label format sets. Label format sets create a group of labels which have a particular printer type. For example, one set of labels may be printed on one printer, while a different printer from a different manufacturer needs a different set of labels. Or you may want to print a different BATCH label for one product to another, setting the default label format set in the formula header. See LabelFormatSet

Parameters:

labelFormatSets - A list of label format sets

Returns:

A saved list of label format sets

Target Uri:

/label_format_set

Request Type:

POST

setLabelFormatSetLink

public javax.ws.rs.core.Response setLabelFormatSetLink(java.util.List<LabelFormatSetLink> labelFormatSetLinks)

Imports the link between label format sets and label format types with associated label data. This is essentially the label data for a given combination of format set and type. See LabelFormatSetLink

Parameters:

labelFormatSetLinks - A list of labels for a given format set and label type.

Returns:

The saved list of LabelFormatSetLinks with response code

Target Uri:

/label_format_set_link

Request Type:

POST

setLabelPrinterType

public javax.ws.rs.core.Response setLabelPrinterType(java.util.List<LabelPrinterType> labelPrinterTypes)

Imports a label printer type. This can be defined as a supported printer manufacturer. Needs to be a manufacturer supported by SG V5. E.G. EPSON, INTERMEC, ZEBRA. See LabelPrinterType

Parameters:

labelPrinterTypes - A list of label printer types for use in the V5 System

Returns:

A saved list of label printer types with ID's and response codes

Target Uri:

/label_printer_type

Request Type:

POST

setStock

public javax.ws.rs.core.Response setStock(java.util.List<Stock> stock)

Imports a stock header record. The header record contains details which pertain to a unique lot or commodity/lot combination. See StockLocation for the stock detail which links the stock with a Location.

Parameters:

stock - A list of stock header data

Returns:

A saved list of stock header data with response codes

Target Uri:

/stock

Request Type:

POST

setStockLocation

public javax.ws.rs.core.Response setStockLocation(java.util.List<StockLocation> stockLocations)

Imports a stock detail record. This object binds the Stock and Location tables to provide an assessment of how much of which lot is in which location. See Stock for the stock header. See Location for the location.

Parameters:

stockLocations - A list of stock detail data

Returns:

A saved list of stock detail data with response codes

Target Uri:

/stock_location

Request Type:

POST

setClient

public javax.ws.rs.core.Response setClient(java.util.List<Client> clients)

Imports a client record
A Client can be a Supplier or a Customer See Client for details

Parameters:

clients - A list of clients

Returns:

A saved list of client records with response codes

Target Uri:

/client

Request Type:

POST

setPreBatch

public javax.ws.rs.core.Response setPreBatch(java.util.List<PreBatch> preBatches)

Used for importing specific batch sizes rather than using the job import
This URI will allow for the third party to schedule batches in a specific manner rather than allowing the V5 system to use it's logic to schedule the individual batch sizes within a job See PreBatch for details

Parameters:

preBatches - A list of PreBatches

Returns:

A saved list of Jobs

Target Uri:

/pre_batch/

Request Type:

POST

setModifyPurchaseOrder

public javax.ws.rs.core.Response setModifyPurchaseOrder(java.util.List<PurchaseOrder> purchaseOrders)

Imports purchase orders. You can specify a list of purchase order lines within the object or you can just import the header data. See PurchaseOrder

Parameters:

purchaseOrders - The list of purchase orders to be imported

Returns:

Returns saved purchase order instances complete with IDs and response code

Target Uri:

/purchase

Request Type:

POST

setModifySalesOrder

public javax.ws.rs.core.Response setModifySalesOrder(java.util.List<SalesOrder> salesOrders)

Imports sales orders. You can specify a list of sales order lines within the object or you can just import the header data. See SalesOrder

Parameters:

salesOrders - The list of sales orders to be imported

Returns:

Returns saved sales order instances complete with ID and response code

Target Uri:

/sales

Request Type:

POST

setModifyPreBatch

public javax.ws.rs.core.Response setModifyPreBatch(java.util.List<PreBatch> preBatches)

setReturnPurchaseOrder

public javax.ws.rs.core.Response setReturnPurchaseOrder(java.lang.String lotNumber,
                                                        java.lang.String commodityCode,
                                                        java.lang.Double quantity)

setReturnSalesOrder

public javax.ws.rs.core.Response setReturnSalesOrder(java.lang.String saleOrder,
                                                     java.lang.String lotNumber,
                                                     java.lang.Double quantity)

setDeletePurchaseOrder

public javax.ws.rs.core.Response setDeletePurchaseOrder(PurchaseOrder purchaseOrder)

setDeleteSalesOrder

public javax.ws.rs.core.Response setDeleteSalesOrder(SalesOrder salesOrder)

setStockAdjust

public javax.ws.rs.core.Response setStockAdjust(StockAdjustment stockAdjustment)