PANTHEON™ Help

 Toc
 Početna stranica - PANTHEON uputstva
[Collapse]PANTHEON
 [Collapse]PANTHEON priručnici
  [Expand]Vodič po Datalab PANTHEON FarmAccounting
  [Expand]Vodič po PANTHEON Retail
  [Expand]Vodič po DataLab PANTHEON™
  [Expand]Vodič po PANTHEON VET
 [Collapse]PANTHEON korisnički priručnici
  [Expand]Korisnički priručnik za DataLab PANTHEON
  [Expand]Korisnički priručnik za PANTHEON Vet
  [Expand]Korisnički priručnik za PANTHEON Maloprodaju
  [Expand]Korisnički priručnik za PANTHEON Farming
[Collapse]PANTHEON Web
 [Collapse]Vodiči po PANTHEON Web
  [Expand]Vodič za PANTHEON Web Terminal
  [Expand]Vodič po PANTHEON Web Light
  [Expand]Vodič za PANTHEON Web Legal
  [Expand]Arhiva starih proizvoda
 [Collapse]Korisnički priručniki za PANTHEON Web
  [Expand]Kako započeti s programom PANTHEON Web
  [Expand]Korisnički priručnik za PANTHEON Web Light
   Korisnički priručnik za PANTHEON Web Terminal
  [Expand]Korisnički priručnik za PANTHEON Web Legal
  [Expand]Arhiva starih proizvoda
[Collapse]PANTHEON Granule
 [Collapse]Vodič za PANTHEON Granule
  [Expand]Granula Kadrovi
  [Expand]Granula Putni nalozi
  [Expand]Granula Dokumenti i zadaci
  [Expand]Granula Nadzorna ploča
  [Expand]Granula B2B naručivanje
  [Expand]Granula Servis na terenu
  [Expand]Inventar Fiksne Imovine Granula
  [Expand]Granula Inventura skladišta
 [Collapse]Korisnički priručnik za PANTHEON Granule
   Početak
   Primjer korištenja PANTHEON Granula u fiktivnom preduzeću
  [Expand]PANTHEON Granule i aktivacija
  [Expand]Granula Kadrovi
  [Expand]Granula Putni nalozi
  [Expand]Granula Dokumenti i zadaci
  [Expand]Granula B2B Naručivanje
  [Expand]Granula Nadzorna ploča
  [Expand]Granula Servis na terenu
   PANTHEON Granule - česta pitanja i odgovori
  [Expand]Inventar Fiksne Imovine Granula
  [Expand]Inventar u skladištu granula
  [Expand]Arhiva
[Collapse]Korisničke stranice
  Test 2
  Test 3
  Test 5
  TEST_Kreiranje noveg zaposlenika 1000003067
  TEST_Kreiranje noveg zaposlenika 1000003067-MK
  TEST3_Kreiranje novog dokumenta 1000003410-SL
  TEST2_Uređivanje kontaktnih podataka 1000003415-SL
  Test
 [Collapse]Test za CG
   Test podređeni 1
  TEST_Kreiranje noveg zaposlenika 1000003067-BA
  TEST_Kreiranje novog zaposlenika 1000003067-SR
  TEST_Kreiranje noveg zaposlenika 1000003067_EU_ORIG
 [Collapse]Pantheon hosting
  [Expand]Hosting robot
  [Expand]DEMO hosting
  Porez ( cookies )
 [Collapse]Prijava na korisničke stranice
   Registracija za Pantheon korisnike
   Glavna stranica
   Prva posjeta korisničkom sajtu
  Novosti
  Uvod u Wiki
  Upute za stranicu izbornika
 [Collapse]Potpora
  [Expand]Tehnička podrška
   Podrška na daljinu za Host korisnike
  [Expand]Daljinska podrška
  Kako upotrebljavam i dopunjujem wiki ?
 [Collapse]Pomoć
   Pantheon Hosting
   Uporedba verzija pantheona
  [Expand]Dokumentacija
   Vsa navodila
   Video uputstva
   Video novosti
   Pitaj druge korisnike
   Postanite PANTHEON svetovalec
   Sve vijesti
   Svi događaji
   Pregled opomb i planova
   Plan
 [Collapse]Informacije
   Obavijesti
  [Expand]Nastavitev deviznih tečajev
 [Collapse]Moji podaci
   Ugovor o osvježavanju
   Podaci o kompaniji
  [Expand]Pooblaščene osobe
   Dovoljenja
   Lični podaci
   Kontaktni podatci
   Osveževalna pogodba
 [Collapse]Forum
   Spremljanje foruma
 [Collapse]Video
   Instruktivni videozapisi
   Video Ažuriranja
  Portal za razvijače
  Tržnica
 [Collapse]Wiki uputstva
  [Expand]Uvod u wiki
  [Expand]Pretraga po Wikiju
  [Expand]Uređenje Wiki-a
   Pripenjanje dokumentov

Load Time: 750,0124 ms
"
  6613 | 1 | |
Label


API


API interface is RESTful web service that allows you to connect to external applications for various purposes.

API example documentation is accesable on https://paws.datalab.eu

API documentation for your purpose will be accesable on your local host (after instalation of Swagger framework)

 

 

 

Table of contents

  1. Subtitle
  2. Subtitle
  3. Subtitle
  4. Subtitle
  5. Subtitle

1. Subtitle

Created API's are designed very general. So user can customize it to various way to meet there needs.

Currently there are four categories of web services API's:

- DBObjects

- Items

-Subjects

-Users

Under each category are specified API methods that can be used (GET, POST and PUT). Each method has it's description in title.

DBObjects category

In this chategory there are API's with which you can get, insert or update almost any data from or to Pantheon.

POST/API/Dbobjects/execproc

This API enables you to execute one or more procedures. If procedure uses Temp Tables it can be specified in the  tempTables array parameters.  In block procParams you must specify the procedure parameters. The results can presentet in JSON file in the structure as the procedure returns the results.

POST/API/Dbobjects/selecttables

This API enables you to define to get data as result of query defined as parameter masterTable with join tables in params tableFKs with custom Conditions in customConditions params. Additional you can sort your data with param sortColumn and sortOrder.  You can use param tempTable in the if you execute store procedure with result set.

{   "start": 0,   "length": 0,     "masterTable": {
    "table": "string",
    "alias": "string"
  },
  "fieldsToReturn": "string",   "tableFKs": [     {       "table": "string",       "alias": "string",       "join": "string"     }   ],   "customConditions": {     "conditions": "string",     "params": [       "string"     ]   },   "sortColumn": "string",   "sortOrder": "string",   "withSubSelects": 0,     "tempTables": [     "string"   ] }  

 

POST/API/Dbobjects/inserttable

This API enables you to insert data into table defined in param masterTable additional the tempTables can be created with param tempTables and insert data in this temp table.

{   "masterTable": "string",   "fieldvalues": {     "additionalProp1": "string",     "additionalProp2": "string",     "additionalProp3": "string"   }  }

POST/API/Dbobjects/updatetable

This API enables you to update data in tabele as as parameter masterTable, update data in param fieldvalues with ability to join tables in params tableFKs with custom Conditions in customConditions params. 

 

 

- POST/API/Ident/retrieve

This API enables you to to get Item data as result of query defined THE_SetItem as masterTable with ability to join tables in params tableFKs with custom Conditions in customConditions params. Additional you can sort your data with param sortColumn and sortOrder.  Param withSubSelect  can be used to structure result set in JSON.  If param withSubSelect is  0 then it show reusult set in flet structure. If param withSubSelect  is 1 then it will show the result set in nested structure.

{   "start": 0,   "length": 0,   "fieldsToReturn": "string",   "tableFKs": [     {       "table": "string",       "alias": "string",       "join": "string"     }   ],   "customConditions": {     "conditions": "string",     "params": [       "string"     ]   },   "sortColumn": "string",   "sortOrder": "string",   "withSubSelects": 0 }  

POST/API/Ident

This API enables you to insert single item 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-20T08:51:11.561Z",   "prStUpdateUserId": 0,   "prStUpdateTime": "2022-04-20T08:51:11.561Z",   "prStCheckUserId": 0,   "prStCheckTime": "2022-04-20T08:51:11.561Z",   "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-20T08:51:11.561Z",   "userIns": 0,   "timeChg": "2022-04-20T08:51:11.561Z",   "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-20T08:51:11.561Z",   "fieldDb": "2022-04-20T08:51:11.561Z",   "fieldDc": "2022-04-20T08:51:11.561Z",   "fieldDd": "2022-04-20T08:51:11.561Z",   "minMargin": 0,   "discountBegin": "2022-04-20T08:51:11.561Z",   "discountEnd": "2022-04-20T08:51:11.561Z",   "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" }

{   "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-19T11:41:17.034Z",   "prStUpdateUserId": 0,   "prStUpdateTime": "2022-04-19T11:41:17.034Z",   "prStCheckUserId": 0,   "prStCheckTime": "2022-04-19T11:41:17.034Z",   "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-19T11:41:17.034Z",   "userIns": 0,   "timeChg": "2022-04-19T11:41:17.034Z",   "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-19T11:41:17.034Z",   "fieldDb": "2022-04-19T11:41:17.034Z",   "fieldDc": "2022-04-19T11:41:17.034Z",   "fieldDd": "2022-04-19T11:41:17.034Z",   "minMargin": 0,   "discountBegin": "2022-04-19T11:41:17.034Z",   "discountEnd": "2022-04-19T11:41:17.034Z",   "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" }

 

PUT/API/Ident This API enables you to update single item 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-19T11:43:52.278Z",   "prStUpdateUserId": 0,   "prStUpdateTime": "2022-04-19T11:43:52.278Z",   "prStCheckUserId": 0,   "prStCheckTime": "2022-04-19T11:43:52.278Z",   "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-19T11:43:52.278Z",   "userIns": 0,   "timeChg": "2022-04-19T11:43:52.278Z",   "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-19T11:43:52.278Z",   "fieldDb": "2022-04-19T11:43:52.278Z",   "fieldDc": "2022-04-19T11:43:52.278Z",   "fieldDd": "2022-04-19T11:43:52.278Z",   "minMargin": 0,   "discountBegin": "2022-04-19T11:43:52.278Z",   "discountEnd": "2022-04-19T11:43:52.278Z",   "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" }   

POST/API/Subject/retrieve   This API enables you to to get Item data as result of query defined THE_SetSubj as masterTable with ability to join tables in params tableFKs with custom Conditions in customConditions params. Additional you can sort your data with param sortColumn and sortOrder Param withSubSelect  can be used to structure result set in JSON.  If param withSubSelect is  0 then it show reusult set in flet structure. If param withSubSelect  is 1 then it will show the result set in nested structure.

{   "start": 0,   "length": 0,   "fieldsToReturn": "string",   "tableFKs": [     {       "table": "string",       "alias": "string",       "join": "string"     }   ],   "customConditions": {     "conditions": "string",     "params": [       "string"     ]   },   "sortColumn": "string",   "sortOrder": "string",   "withSubSelects": 0 }  

POST/API/Subject This API enables you to insert single sublject data into THE_SetISubj master table in the specified structure.

  {   "subject": "string",   "buyer": "string",   "supplier": "string",   "bank": "string",   "municipality": "string",   "locComm": "string",   "warehouse": "string",   "worker": "string",   "user": "string",   "dept": "string",   "school": "string",   "institution": "string",   "name2": "string",   "address": "string",   "name3": "string",   "post": "string",   "country": "string",   "km": 0,   "vatcodePrefix": "string",   "code": "string",   "region": "string",   "suprCommune": "string",   "phone": "string",   "fax": "string",   "subUnit": "string",   "priceRate": "string",   "daysForPayment": 0,   "yearStatement": "string",   "dateState": "2022-04-19T11:46:44.290Z",   "statement": "string",   "limit": 0,   "dateLimit": "2022-04-19T11:46:44.290Z",   "maxDaysPayDelay": 0,   "subjTypeSupp": "string",   "subjTypeBuyer": "string",   "stockManage": "string",   "stockValue": "string",   "stockInMinus": "string",   "dateInvent": "2022-04-19T11:46:44.290Z",   "clerk": 0,   "rebate": 0,   "wayOfSale": "string",   "currency": "string",   "priceCalcMethod": "string",   "payMethod": "string",   "delivery": "string",   "regNo": "string",   "acPayer": "string",   "activityCode": "string",   "separSaleCalc": "string",   "suppPriceCalcMet": "string",   "suppDiscount": 0,   "suppSaleMet": "string",   "suppYearStatement": "string",   "suppDateSta": "2022-04-19T11:46:44.290Z",   "suppPayDays": 0,   "suppPayMet": "string",   "suppStatement": "string",   "suppLimit": 0,   "suppDateLim": "2022-04-19T11:46:44.290Z",   "suppDelivery": "string",   "suppCurr": "string",   "suppClerk": 0,   "payOrdPriorty": "string",   "swiftcode": "string",   "atwarehouse": "string",   "municipCode": "string",   "dispDoc": "string",   "setOfInterestRates": "string",   "stockRetailValue": "string",   "parity": "string",   "parityPost": "string",   "suppParity": "string",   "suppParityPost": "string",   "fieldSa": "string",   "fieldSb": "string",   "fieldSc": "string",   "fieldSd": "string",   "fieldSe": "string",   "fieldSf": "string",   "fieldSg": "string",   "fieldSh": "string",   "fieldSi": "string",   "fieldSj": "string",   "fieldNa": 0,   "fieldNb": 0,   "fieldNc": 0,   "fieldNd": 0,   "fieldNe": 0,   "fieldNf": 0,   "fieldNg": 0,   "fieldNh": 0,   "fieldNi": 0,   "fieldNj": 0,   "fieldDa": "2022-04-19T11:46:44.290Z",   "fieldDb": "2022-04-19T11:46:44.290Z",   "fieldDc": "2022-04-19T11:46:44.290Z",   "fieldDd": "2022-04-19T11:46:44.290Z",   "skis": "string",   "xmldocType": "string",   "xmldocCript": "string",   "xmldocSign": "string",   "createPayOrd": "string",   "xmlglnno": "string",   "intrstsBuyer": "string",   "intrstsSupplier": "string",   "rsbainDistrikt": "string",   "httppath": "string",   "ibanprefix": "string",   "suprDept": "string",   "subjVar1": 0,   "subjVar2": 0,   "subjVar3": 0,   "subjVar4": 0,   "subjVar5": 0,   "subjVar6": 0,   "subjVar7": 0,   "subjVar8": 0,   "subjVar9": 0,   "subjVar10": 0,   "latitude": 0,   "longitude": 0,   "maxRebate": 0,   "perInv": "string",   "suppPerInv": "string",   "active": "string",   "activeContacts": "string",   "deptRegNo": "string",   "payLoc": "string",   "buyerLimitCtrl": "string",   "timeIns": "2022-04-19T11:46:44.290Z",   "userIns": 0,   "timeChg": "2022-04-19T11:46:44.290Z",   "userChg": 0,   "subUnitCode": "string",   "jibcode": "string",   "note": "string",   "pin": "string",   "deptMuni": "string",   "contactPrsnB": 0,   "contactPrsnS": 0,   "subUnitRegNo": "string",   "subUnitTaxCode": "string",   "workingHours": 0,   "workingDaysInWeek": 0,   "budgetUser": "string",   "exciseNumber": "string",   "instalmentNo": 0,   "suppInstalmentNo": 0,   "branch": "string",   "branchForm": "string",   "orgColor": 0,   "loyaltyPrefix": "string",   "dontSendReminders": "string",   "gln": "string",   "municipCreditor": "string",   "bankCode": "string",   "qid": 0,   "retail": "string",   "fiscalNo": "string",   "payerS": "string",   "acctClaim": "string",   "acctOblig": "string",   "eSlogVer": "string",   "pincodePrefix": "string",   "acctGlopen": "string",   "noExciseCalc": "string",   "rsbainDistriktBuyer": "string",   "vatpayRealSupp": "string",   "warehouseCapacity": 0,   "warehouseCapacityUm": "string",   "acctExpense": "string",   "acctIncome": "string",   "permitLumpCompen": "string",   "remindersSendType": "string",   "pac": "string",   "eslogContractCt": "string",   "skis2": "string",   "allowedInvShort": 0,   "acctRebateExtra": "string",   "veterinarian": "string",   "anafcheckDate": "2022-04-19T11:46:44.290Z",   "parityType": "string",   "suppParityType": "string",   "naturalPerson": "string",   "minMargin": 0,   "ncc": "string",   "buyerCalcInvoOutFallDue": "string",   "assortment": "string",   "orgUnit": "string",   "accountingPeriod": "string",   "orderValidBuyer": 0,   "orderValidSupplier": 0,   "lei": "string",   "freeStockReport": "string",   "webShopSubject": "string",   "deliveryPriority": 0,   "deliveryDays": 0,   "priceRatePos": true }

 

PUT/API/Subject/

This API enables you to update single subject data into THE_SetISubj master table in the specified structure.

THE_SetSubj master table in the specified structure. {   "subject": "string",   "buyer": "string",   "supplier": "string",   "bank": "string",   "municipality": "string",   "locComm": "string",   "warehouse": "string",   "worker": "string",   "user": "string",   "dept": "string",   "school": "string",   "institution": "string",   "name2": "string",   "address": "string",   "name3": "string",   "post": "string",   "country": "string",   "km": 0,   "vatcodePrefix": "string",   "code": "string",   "region": "string",   "suprCommune": "string",   "phone": "string",   "fax": "string",   "subUnit": "string",   "priceRate": "string",   "daysForPayment": 0,   "yearStatement": "string",   "dateState": "2022-04-19T11:48:26.235Z",   "statement": "string",   "limit": 0,   "dateLimit": "2022-04-19T11:48:26.235Z",   "maxDaysPayDelay": 0,   "subjTypeSupp": "string",   "subjTypeBuyer": "string",   "stockManage": "string",   "stockValue": "string",   "stockInMinus": "string",   "dateInvent": "2022-04-19T11:48:26.235Z",   "clerk": 0,   "rebate": 0,   "wayOfSale": "string",   "currency": "string",   "priceCalcMethod": "string",   "payMethod": "string",   "delivery": "string",   "regNo": "string",   "acPayer": "string",   "activityCode": "string",   "separSaleCalc": "string",   "suppPriceCalcMet": "string",   "suppDiscount": 0,   "suppSaleMet": "string",   "suppYearStatement": "string",   "suppDateSta": "2022-04-19T11:48:26.235Z",   "suppPayDays": 0,   "suppPayMet": "string",   "suppStatement": "string",   "suppLimit": 0,   "suppDateLim": "2022-04-19T11:48:26.235Z",   "suppDelivery": "string",   "suppCurr": "string",   "suppClerk": 0,   "payOrdPriorty": "string",   "swiftcode": "string",   "atwarehouse": "string",   "municipCode": "string",   "dispDoc": "string",   "setOfInterestRates": "string",   "stockRetailValue": "string",   "parity": "string",   "parityPost": "string",   "suppParity": "string",   "suppParityPost": "string",   "fieldSa": "string",   "fieldSb": "string",   "fieldSc": "string",   "fieldSd": "string",   "fieldSe": "string",   "fieldSf": "string",   "fieldSg": "string",   "fieldSh": "string",   "fieldSi": "string",   "fieldSj": "string",   "fieldNa": 0,   "fieldNb": 0,   "fieldNc": 0,   "fieldNd": 0,   "fieldNe": 0,   "fieldNf": 0,   "fieldNg": 0,   "fieldNh": 0,   "fieldNi": 0,   "fieldNj": 0,   "fieldDa": "2022-04-19T11:48:26.235Z",   "fieldDb": "2022-04-19T11:48:26.235Z",   "fieldDc": "2022-04-19T11:48:26.235Z",   "fieldDd": "2022-04-19T11:48:26.235Z",   "skis": "string",   "xmldocType": "string",   "xmldocCript": "string",   "xmldocSign": "string",   "createPayOrd": "string",   "xmlglnno": "string",   "intrstsBuyer": "string",   "intrstsSupplier": "string",   "rsbainDistrikt": "string",   "httppath": "string",   "ibanprefix": "string",   "suprDept": "string",   "subjVar1": 0,   "subjVar2": 0,   "subjVar3": 0,   "subjVar4": 0,   "subjVar5": 0,   "subjVar6": 0,   "subjVar7": 0,   "subjVar8": 0,   "subjVar9": 0,   "subjVar10": 0,   "latitude": 0,   "longitude": 0,   "maxRebate": 0,   "perInv": "string",   "suppPerInv": "string",   "active": "string",   "activeContacts": "string",   "deptRegNo": "string",   "payLoc": "string",   "buyerLimitCtrl": "string",   "timeIns": "2022-04-19T11:48:26.236Z",   "userIns": 0,   "timeChg": "2022-04-19T11:48:26.236Z",   "userChg": 0,   "subUnitCode": "string",   "jibcode": "string",   "note": "string",   "pin": "string",   "deptMuni": "string",   "contactPrsnB": 0,   "contactPrsnS": 0,   "subUnitRegNo": "string",   "subUnitTaxCode": "string",   "workingHours": 0,   "workingDaysInWeek": 0,   "budgetUser": "string",   "exciseNumber": "string",   "instalmentNo": 0,   "suppInstalmentNo": 0,   "branch": "string",   "branchForm": "string",   "orgColor": 0,   "loyaltyPrefix": "string",   "dontSendReminders": "string",   "gln": "string",   "municipCreditor": "string",   "bankCode": "string",   "qid": 0,   "retail": "string",   "fiscalNo": "string",   "payerS": "string",   "acctClaim": "string",   "acctOblig": "string",   "eSlogVer": "string",   "pincodePrefix": "string",   "acctGlopen": "string",   "noExciseCalc": "string",   "rsbainDistriktBuyer": "string",   "vatpayRealSupp": "string",   "warehouseCapacity": 0,   "warehouseCapacityUm": "string",   "acctExpense": "string",   "acctIncome": "string",   "permitLumpCompen": "string",   "remindersSendType": "string",   "pac": "string",   "eslogContractCt": "string",   "skis2": "string",   "allowedInvShort": 0,   "acctRebateExtra": "string",   "veterinarian": "string",   "anafcheckDate": "2022-04-19T11:48:26.236Z",   "parityType": "string",   "suppParityType": "string",   "naturalPerson": "string",   "minMargin": 0,   "ncc": "string",   "buyerCalcInvoOutFallDue": "string",   "assortment": "string",   "orgUnit": "string",   "accountingPeriod": "string",   "orderValidBuyer": 0,   "orderValidSupplier": 0,   "lei": "string",   "freeStockReport": "string",   "webShopSubject": "string",   "deliveryPriority": 0,   "deliveryDays": 0,   "priceRatePos": true }  

 

User Authentication

There are four ways to autenticate user.

1. atNone ("AuthType": "atNone") 

If the Parama AuthType is set to atNone in this case there is no autentification, the user is taken form the connection string in appsettings.json file

 

 

2. atUser ("AuthType": "atUser")

If param AuthType is set to atUser in this case at each connection the user and password are send to create connection string.


Example for Advanced REST client:


 

Selected Basic authorisation allowes you to send username and password in a request header.

Or you can enter in service HEADER:

authorization: Basic XXXXXXXXXXXX
where  XXXXXXXXXXXX is base64 encripted username:password

Or you can use some other authentication method which is allowed by client aplication.

 

3. POST/API/Users/Authwithcookie

This API generate cookie atCookie ("AuthType": "atCookie") for autorisation in JSON form.

User and password will be send in .json format.
{

"username": "string",

  "password": "string"

}

 

Expiration in minutes is set in param  "CookieExpiresMinutes": 2,


 

4. POST/API/Users/Authwithtoken

This API gnerate token atToken ("AuthType": "atToken",) in JSON form needed for autorisation in each API service call.

{

"username": "string",

  "password": "string"

}

 

User and password will be send in .json format.

Selected Bearer authorization allows to send an authentication token in the authorization header using the 'bearer' method.

Or you can add token in the service HEADER.

authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

 


Token Expiration in days: "TokenExpiresDays": 1,

Tokens can be in  JWT or JSON Web Tokens (https://jwt.io/).

 

Shemas

In this section you find the specification of all parameters that are used in API queries.

 

Hint

This is a HINT and should be marked with this icon. If necessary, copy this whole table and add a new hint.

 

Warning

User is primary set up in appsettings.json file

 

3. Subtitle

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Entry 1 Description of entry
Entry 2 Description of entry
Entry 3 Description of entry
Entry 4 Description of entry
Entry 5 Description of entry
Entry 6 Description of entry

4. Subtitle

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

5. Subtitle

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

 

 

  

     


Rate this topic
Was this topic usefull?
Comments
Comment will also bo visible in forum!