Kapcsolódó információk:
› Paraméterezési útmutatók

A DbConnector REST API felületen keresztül a SUP® gyűjtők törzs állománya karbantartása is kezdeményezhető. Tehát lehetőség van új gyűjtő adat felvitelre, valamint a meglévők módosítására.

Az API a következő belépési ponton érhető el. A szerver név a helyi intranetet környezettől függ.

A válaszok XML-ben érkeznek.

A REST API hívások általános használata a DbConnector REST API oldalon található.

POST

http://server/dbconnector/api/torzs/gyujtok

Header paraméterek: az API használathoz szükséges pkod, lickod, cegkod paraméterek.


A gyűjtő adatok karbantartására a következő lehetőségek vannak

Gyűjtő csoport felvitele, módosítása

A gyűjtő csoportok API-n keresztüli módosítása nem ajánlott. A funkció csak a teljesség kedvéért került implementálásra. A gyűjtő csoport kód helyett használható a gyűjtők törzs lekérdezés funkcióknál használt ENUM lista.

POST

   http://server/dbconnector/api/torzs/gyujtok/{gycsopkod}
   http://server/dbconnector/api/torzs/gyujtok/{kiemgycsoptip}

Paraméter (kötelező):  XML, Az alábbi séma szerint.

Kérés minta
CURL.EXE 	^
  -X POST   ^
     http://server:8080/dbconnector/api/torzs/gyujtok/0002 ^
  -H pkod:SajatSupPartnerKod  ^
  -H lickod:SajatSupLicKod    ^
  -H cegkod:UJV_TEST          ^
  -H "Content-Type:application/xml"  ^
  --data-ascii @testEgyGyCsop.xml
Kérés minta
<?xml version="1.0" encoding="UTF-8"?>
<GyCsoport>
	<GyCsopKod>0002</GyCsopKod>
	<GyCsopNev>Belső kód</GyCsopNev>
	<Tipus>N</Tipus>
	<Ervenyes>True</Ervenyes>
</GyCsoport>
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <Message>INSERT</Message>
</DbConnectorResponse>

Az API verb hívásnál megadott csoport kódnak, és XML-ben használt <GyCsopKod> adatnak meg kell egyeznie.

Gyűjtő azonosító felvitele, módosítása

A funkció az egyes gyűjtő csoportokon belül használt gyűjtő azonosító kódok felvitelére és módosítására ad lehetőséget. Az új gyűjtő azonosítók (pl.: munkaszám, project, stb.) gyakran a kapcsolódó alrendszerben jelennek meg először. Az API hívás segítségével ezek beküldhetők a SUP rendszer adatbázisába.
A gyűjtő csoport kód helyett használható a gyűjtők törzs lekérdezés funkcióknál használt ENUM lista.

POST

http://server/dbconnector/api/torzs/gyujtok/{gycsopkod}/{gyazonkod}  
http://server/dbconnector/api/torzs/gyujtok/{kiemgycsoptip}/{gyazonkod}

Paraméter (kötelező):  XML, Az alábbi séma szerint.

Kérés minta
CURL.EXE 	^
  -X POST   ^
     http://server:8080/dbconnector/api/torzs/gyujtok/0009/ABC123 ^
  -H pkod:SajatSupPartnerKod  ^
  -H lickod:SajatSupLicKod    ^
  -H cegkod:UJV_TEST          ^
  -H "Content-Type:application/xml"  ^
  --data-ascii @testEgyGyAzon.xml
Kérés minta
<?xml version="1.0" encoding="UTF-8"?>
<GyAzon>
	<GyAzonKod>ABC123</GyAzonKod>
	<GyAzonNev>Nagybékás lakópark</GyAzonNev>
    <!--A gyűjtő típustól függő további adatok-->
	<MSzLezarDatum>2021-01-31</MSzLezarDatum>
	<Ervenyes>false</Ervenyes>
</GyAzon>
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <Message>UPDATE</Message>
</DbConnectorResponse>

Az API verb hívásnál megadott gyűjtő azonosító kódnak, és XML-ben használt <GyAzonKod> adatnak meg kell egyeznie.