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

Ez az oldal egy régebbi verziója. Nézze meg a jelenlegi verziót.

Összehasonlítás a jelenlegivel Korábbi változatok megtekintése

« Előző 3 verzió Aktuális »

A DbConnector REST API felületen keresztül a SUP® gyűjtők törzs állománya is hozzáférhető intranetes webszolgáltatásként.
A webszolgáltatás XML alapú REST API hívásokkal működtethető.

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ó.

GET

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 lekérdezésre a következő lehetőségek vannak

Gyűjtő csoportok és azonosítók

A SUP® rendszerben a feldolgozás során használt analitikus kódok (gyűjtők, dimenziók, és további elnevezések is léteznek más rendszerekben) egységesen gyűjtő csoport - gyűjtő azonosító szerkezetben vannak tárolva.
A gyűjtő csoport az adott analitikus csoport (dimenzió) neve (pl.: költséghely, munkaszám, gépkocsi rendszám, stb.). A gyűjtő azonosító pedig az egyes gyűjtő csoportokon belül használható kódok listája. (pl.: munkaszám kódok). A REST API ezt a logikát követi.

Gyűjtő csoportok lekérdezése

A gyűjtő csoportok kis számossága miatt az általános REST API konvenciót megtörve, nem a <ResultList> adattagon adja vissza a a gyűjtő csoportok listáját, hanem közvetlenül XML tömbként.

GET

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

Paraméter: nincs

Result: a gyűjtő csoportok részletes adatai.

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/gyujtok  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <ResultListCnt>4</ResultListCnt>
  <GyCsoportok version="GTC_1.0">
    <GyCsoport>
      <GyCsopKod>0001</GyCsopKod>
      <GyCsopNev>Költséghelyek</GyCsopNev>
      <Tipus>KTH</Tipus>
    </GyCsoport>
    <GyCsoport>
      <GyCsopKod>0005</GyCsopKod>
      <GyCsopNev>Dolgozók</GyCsopNev>
      <Tipus>DLG</Tipus>
      <UiKod/>
    </GyCsoport>
    <GyCsoport>
      <GyCsopKod>0006</GyCsopKod>
      <GyCsopNev>Telefonok</GyCsopNev>
      <Tipus>N</Tipus>
    </GyCsoport>
    <GyCsoport>
      <GyCsopKod>0007</GyCsopKod>
      <GyCsopNev>Gépkocsik</GyCsopNev>
      <Tipus>N</Tipus>
    </GyCsoport>
  </GyCsoportok>
</DbConnectorResponse>
 Megjegyzés

A SUP® rendszerben a gyűjtő csoportokat a <GyCsopKod> azonosítja. Vannak viszont úgynevezett kiemelt gyűjtő csoport típusok. Ezek esetében a gyűjtő csoport kódja helyett az URL-ben a kiemelt gyűjtőcsoportot azonosító ENUM is szerepelhet. A gyűjtő csoport kódok adatbázisonként eltérhetnek. A kiemelt gyűjtő csoportok ENUM lista adatbázis-független.
A kiemelt gyűjtő csoport típusok listája a következő:
        OEL - Önelszámoló egység
        KTH - Költséghely
        MSZ - Munkaszám
        PLY - Pályázat
        DLG - Dolgozó
        UZK - Üzletkötő
        PRT - Partner

Egy gyűjtő csoport lekérdezése - gyűjtő azonosítók listája

Egy gyűjtő csoport részletes adatai a következő verb-en érhető el. A gyűjtő csoport részletes adatai tartalmazzák <ResultList> adatként a csoporton belüli azonosítók listáját..

GET

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

Paraméter: nincs

Result: a gyűjtő csoport részletes adatai XML tömbként, és ezen belül az ehhez tartozó gyűjtő azonosítók listája

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/gyujtok/0001  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <GyCsoport>
    <GyCsopKod>0001</GyCsopKod>
    <GyCsopNev>Ktgh</GyCsopNev>
    <Tipus>KTH</Tipus>
    <GyAzonKodList>01,02,03,04</GyAzonKodList>
  </GyCsoport>
</DbConnectorResponse>

Egy gyűjtő azonosító lekérdezése

Egy gyűjtő azonosító részletes adatai a következő verb-en érhető el. .

GET

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

Paraméter: nincs

Result: a gyűjtő azonosító részletes adatai XML tömbként

Kérés minta
CURL.EXE    ^
  -X GET    ^
     http://server:8080/dbconnector/api/torzs/gyujtok/0001/01  ^
  -H pkod:SajatSupPartnerKod   ^
  -H lickod:SajatSupLicKod     ^
  -H cegkod:CegKod
Válasz minta
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DbConnectorResponse>
  <Success>true</Success>
  <StatusCode>200</StatusCode>
  <GyAzon>
    <GyCsopKod>0001</GyCsopKod>
    <GyAzonKod>01</GyAzonKod>
    <GyAzonNev>Központ</GyAzonNev>
    <Ervenyes>true</Ervenyes>
    <!--A gyűjtő típustól függő további adatok-->
  </GyAzon>
</DbConnectorResponse>