Ident APIs
In this chategory, you will find APIs that enable you to get the images of idents (items), get all idents with all fields, insert idents into the database or update existing idents in the database.
Table of contents
- GET/api/Ident/picture
- POST/api/Ident/retrieve
- POST/api/Ident
- PUT/api/Ident
|
1. Short description of Ident APIs
|
GET/api/Ident/picture
|
Gets the image of the ident. |
|
POST/api/Ident/retrieve
|
Gets all idents with all fields. |
|
POST/api/Ident
|
Inserts an ident into the database. |
|
PUT/api/Ident
|
Updates an existing ident in the database. |
2. GET/api/Ident/ picture
This API enables you to get ident image as a result of a query defined THE_SetItem as masterTable with the parameter Ident.
3. POST/api/Ident/retrieve
This API enables you to to get ident data as result of a query defined THE_SetItem as masterTable with ability to join tables in the parameters tableFKs with custom conditions in the parameters customConditions.
Additionally, you can sort your data using the parameters sortColumn and sortOrder.
The parameter withSubSelect can be used to structure the result set as a .json file.
If the parameter withSubSelect is 0, then the result set will be shown in a flat structure. If the parameter withSubSelect is 1, then the result set will be shown in a nested structure.
{
"start": 0,
"length": 0,
"fieldsToReturn": "string",
"tableFKs": [
{
"table": "string",
"alias": "string",
"join": "string",
"parentAlias": "string",
"fieldsToReturn": "string"
}
],
"customConditions": {
"condition": "string",
"params": [
"string"
]
},
"sortColumn": "string",
"sortOrder": "string",
"withSubSelects": 0
}
4. POST/api/Ident
This API enables you to insert single ident data into THE_SetItem master table in the specified structure.
{
"ident": "string",
"name": "string",
"classif": "string",
"subClassif": 0,
"classif2": "string",
"code": "string",
"setOfItem": "string",
"supplier": "string",
"formula": "string",
"vat": 0,
"currency": "string",
"salePrice": 0,
"rtprice": 0,
"wsprice": 0,
"wsprice2": 0,
"prStPrice": 0,
"prodPrice": 0,
"buyPrice": 0,
"um": "string",
"umtoUm2": 0,
"um2": "string",
"vatcode": "string",
"vatcodeLow": "string",
"discount": 0,
"warrenty": 0,
"serialNo": "string",
"active": "string",
"httppath": "string",
"makeCalc": "string",
"price": 0,
"rebate": 0,
"transport": 0,
"duty": 0,
"directCost": 0,
"incTax": 0,
"wsprice2P": 0,
"wspriceP": 0,
"rtpriceP": 0,
"minStock": 0,
"standardize": "string",
"docTypeProd": "string",
"docTypeOrdSupp": "string",
"dimHeight": 0,
"dimWidth": 0,
"dimDepth": 0,
"dimWeight": 0,
"dimWeightBrutto": 0,
"custTariff": "string",
"priceSupp": 0,
"prStPriceP": 0,
"purchCurr": "string",
"orderTransInMf": "string",
"origin": "string",
"declarForOriginType": "string",
"acct": "string",
"fieldSa": "string",
"fieldSb": "string",
"fieldSc": "string",
"fieldNa": 0,
"fieldNb": 0,
"evidence": "string",
"excise": 0,
"exciseP": 0,
"maxStock": 0,
"optStock": 0,
"declarForOrigin": "string",
"dept": "string",
"qtyInCode": "string",
"umdim1": "string",
"umdim2": "string",
"wasteQty": 0,
"umseries": "string",
"qtySeries": 0,
"column": "string",
"umtoUm3": 0,
"um3": "string",
"umtoDeclarReport": 0,
"reportDeclar": "string",
"fieldNc": 0,
"fieldNd": 0,
"fieldNe": 0,
"fieldSd": "string",
"fieldSe": "string",
"prstTime": 0,
"prstUmtime": "string",
"prStInsertUserId": 0,
"prStInsertTime": "2022-04-21T07:54:54.799Z",
"prStUpdateUserId": 0,
"prStUpdateTime": "2022-04-21T07:54:54.799Z",
"prStCheckUserId": 0,
"prStCheckTime": "2022-04-21T07:54:54.799Z",
"prStVariantValid": 0,
"prStOptimalQty": 0,
"prStDailyQty": 0,
"unionDeadline": 0,
"deliveryDeadline": 0,
"posqty": 0,
"showAtena": "string",
"acctIncome": "string",
"inFlowOutFlow": "string",
"fieldNf": 0,
"fieldNg": 0,
"fieldSf": "string",
"fieldSg": "string",
"fieldSh": "string",
"fieldSi": "string",
"fieldSj": "string",
"fieldNh": 0,
"fieldNi": 0,
"fieldNj": 0,
"fixPriceDiff": 0,
"qtyInCodeDecPlace": 0,
"orderMinQty": 0,
"orderOptQty": 0,
"costDrv": "string",
"packing": "string",
"purExciseE": 0,
"purExciseA": 0,
"purExciseT": 0,
"beatShare": 0,
"timeIns": "2022-04-21T07:54:54.799Z",
"userIns": 0,
"timeChg": "2022-04-21T07:54:54.799Z",
"userChg": 0,
"isReturnPack": "string",
"envrmntCost": "string",
"wastePack": "string",
"wstEeequip": "string",
"usedTyre": "string",
"vehiclePart": "string",
"packSlopak": "string",
"packSlopaktype": "string",
"ummarkLabel": "string",
"qtyMarkLabel": 0,
"prstPriceString": "string",
"plucode": 0,
"dateDue": "string",
"monthDue": 0,
"picture": "string",
"maxRebate": 0,
"techProcedure": "string",
"descr": "string",
"touchPicture": "string",
"droe": "string",
"droesubject": "string",
"fieldDa": "2022-04-21T07:54:54.799Z",
"fieldDb": "2022-04-21T07:54:54.799Z",
"fieldDc": "2022-04-21T07:54:54.799Z",
"fieldDd": "2022-04-21T07:54:54.799Z",
"minMargin": 0,
"discountBegin": "2022-04-21T07:54:54.799Z",
"discountEnd": "2022-04-21T07:54:54.799Z",
"docTypeIssue": "string",
"enableChgPrSt": "string",
"note": "string",
"plucode2": 0,
"buyRebate2": 0,
"buyRebate3": 0,
"saleRebate2": 0,
"saleRebate3": 0,
"posQtyStep": 0,
"qtyNotToKol": "string",
"qid": 0,
"stretchPicture": "string",
"backPacking": "string",
"formulaRt": "string",
"acctNotTaxDeduct": "string",
"prtPicture": "string",
"classProdByAct": "string",
"bullId": "string",
"posprinterId": "string",
"bst": "string",
"vatcodeReceive": "string",
"vatreceive": 0,
"weighableItem": "string",
"allowedWastage": 0,
"serialnoDueType": "string",
"packagingType": "string",
"transferredWs": "string",
"colorCode": 0,
"icon": "string",
"allowedInvShort": 0,
"acctBuyVasale": "string",
"packWeight": 0,
"packWasteWeight": 0,
"discountPrice": 0,
"discountPriceRt": 0,
"useAsCostOnIntrastat": "string",
"printTechProc": "string",
"roundQtyToInt": true,
"convertToUmForPos": true,
"umForPos": "string",
"webShopItem": "string",
"useAsCostOnVatba": "string",
"descrRtf": "string",
"techProcedureRtf": "string",
"vatcodeReduced": "string"
}
5. PUT/api/Ident
This API enables you to update single ident data into the THE_SetItem master table in the specified structure.
{
"ident": "string",
"name": "string",
"classif": "string",
"subClassif": 0,
"classif2": "string",
"code": "string",
"setOfItem": "string",
"supplier": "string",
"formula": "string",
"vat": 0,
"currency": "string",
"salePrice": 0,
"rtprice": 0,
"wsprice": 0,
"wsprice2": 0,
"prStPrice": 0,
"prodPrice": 0,
"buyPrice": 0,
"um": "string",
"umtoUm2": 0,
"um2": "string",
"vatcode": "string",
"vatcodeLow": "string",
"discount": 0,
"warrenty": 0,
"serialNo": "string",
"active": "string",
"httppath": "string",
"makeCalc": "string",
"price": 0,
"rebate": 0,
"transport": 0,
"duty": 0,
"directCost": 0,
"incTax": 0,
"wsprice2P": 0,
"wspriceP": 0,
"rtpriceP": 0,
"minStock": 0,
"standardize": "string",
"docTypeProd": "string",
"docTypeOrdSupp": "string",
"dimHeight": 0,
"dimWidth": 0,
"dimDepth": 0,
"dimWeight": 0,
"dimWeightBrutto": 0,
"custTariff": "string",
"priceSupp": 0,
"prStPriceP": 0,
"purchCurr": "string",
"orderTransInMf": "string",
"origin": "string",
"declarForOriginType": "string",
"acct": "string",
"fieldSa": "string",
"fieldSb": "string",
"fieldSc": "string",
"fieldNa": 0,
"fieldNb": 0,
"evidence": "string",
"excise": 0,
"exciseP": 0,
"maxStock": 0,
"optStock": 0,
"declarForOrigin": "string",
"dept": "string",
"qtyInCode": "string",
"umdim1": "string",
"umdim2": "string",
"wasteQty": 0,
"umseries": "string",
"qtySeries": 0,
"column": "string",
"umtoUm3": 0,
"um3": "string",
"umtoDeclarReport": 0,
"reportDeclar": "string",
"fieldNc": 0,
"fieldNd": 0,
"fieldNe": 0,
"fieldSd": "string",
"fieldSe": "string",
"prstTime": 0,
"prstUmtime": "string",
"prStInsertUserId": 0,
"prStInsertTime": "2022-04-21T07:55:38.773Z",
"prStUpdateUserId": 0,
"prStUpdateTime": "2022-04-21T07:55:38.773Z",
"prStCheckUserId": 0,
"prStCheckTime": "2022-04-21T07:55:38.773Z",
"prStVariantValid": 0,
"prStOptimalQty": 0,
"prStDailyQty": 0,
"unionDeadline": 0,
"deliveryDeadline": 0,
"posqty": 0,
"showAtena": "string",
"acctIncome": "string",
"inFlowOutFlow": "string",
"fieldNf": 0,
"fieldNg": 0,
"fieldSf": "string",
"fieldSg": "string",
"fieldSh": "string",
"fieldSi": "string",
"fieldSj": "string",
"fieldNh": 0,
"fieldNi": 0,
"fieldNj": 0,
"fixPriceDiff": 0,
"qtyInCodeDecPlace": 0,
"orderMinQty": 0,
"orderOptQty": 0,
"costDrv": "string",
"packing": "string",
"purExciseE": 0,
"purExciseA": 0,
"purExciseT": 0,
"beatShare": 0,
"timeIns": "2022-04-21T07:55:38.773Z",
"userIns": 0,
"timeChg": "2022-04-21T07:55:38.773Z",
"userChg": 0,
"isReturnPack": "string",
"envrmntCost": "string",
"wastePack": "string",
"wstEeequip": "string",
"usedTyre": "string",
"vehiclePart": "string",
"packSlopak": "string",
"packSlopaktype": "string",
"ummarkLabel": "string",
"qtyMarkLabel": 0,
"prstPriceString": "string",
"plucode": 0,
"dateDue": "string",
"monthDue": 0,
"picture": "string",
"maxRebate": 0,
"techProcedure": "string",
"descr": "string",
"touchPicture": "string",
"droe": "string",
"droesubject": "string",
"fieldDa": "2022-04-21T07:55:38.773Z",
"fieldDb": "2022-04-21T07:55:38.773Z",
"fieldDc": "2022-04-21T07:55:38.773Z",
"fieldDd": "2022-04-21T07:55:38.773Z",
"minMargin": 0,
"discountBegin": "2022-04-21T07:55:38.773Z",
"discountEnd": "2022-04-21T07:55:38.773Z",
"docTypeIssue": "string",
"enableChgPrSt": "string",
"note": "string",
"plucode2": 0,
"buyRebate2": 0,
"buyRebate3": 0,
"saleRebate2": 0,
"saleRebate3": 0,
"posQtyStep": 0,
"qtyNotToKol": "string",
"qid": 0,
"stretchPicture": "string",
"backPacking": "string",
"formulaRt": "string",
"acctNotTaxDeduct": "string",
"prtPicture": "string",
"classProdByAct": "string",
"bullId": "string",
"posprinterId": "string",
"bst": "string",
"vatcodeReceive": "string",
"vatreceive": 0,
"weighableItem": "string",
"allowedWastage": 0,
"serialnoDueType": "string",
"packagingType": "string",
"transferredWs": "string",
"colorCode": 0,
"icon": "string",
"allowedInvShort": 0,
"acctBuyVasale": "string",
"packWeight": 0,
"packWasteWeight": 0,
"discountPrice": 0,
"discountPriceRt": 0,
"useAsCostOnIntrastat": "string",
"printTechProc": "string",
"roundQtyToInt": true,
"convertToUmForPos": true,
"umForPos": "string",
"webShopItem": "string",
"useAsCostOnVatba": "string",
"descrRtf": "string",
"techProcedureRtf": "string",
"vatcodeReduced": "string"
}