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ő 2 verzió Tovább »

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.

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

A válaszok XML-ben érkeznek.

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

Tartalom

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
   További header paraméterek nem szükségesek

Result
   XML - <GyCsop> : A gyűjtő csoportok adatai XML tömbként.

Hívá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>
    <GyCsopList version="GTC_1.0">
        <GyCsop>
            <GyCsopKod>0001</GyCsopKod>
            <Megnev>Költséghelyek</Megnev>
            <Tipus>KTH</Tipus>
        </GyCsop>
        <GyCsop>
            <GyCsopKod>0005</GyCsopKod>
            <Megnev>Dolgozók</Megnev>
            <Tipus>DLG</Tipus>
            <UiKod/>
        </GyCsop>
        <GyCsop>
            <GyCsopKod>0006</GyCsopKod>
            <Megnev>Telefonok</Megnev>
            <Tipus>N</Tipus>
        </GyCsop>
        <GyCsop>
            <GyCsopKod>0007</GyCsopKod>
            <Megnev>Gépkocsik</Megnev>
            <Tipus>N</Tipus>
        </GyCsop>
    </GyCsopList>
</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/{ENUM}

Paraméter
   További header paraméterek nem szükségesek

Result
   XML - <GyCsop> : A gyűjtő csoportok adatai XML tömbként.

Hívá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>
    <GyCsop>
        <GyCsopKod>0001</GyCsopKod>
        <Megnev>Ktgh</Megnev>
        <Tipus>KTH</Tipus>
        <GyAzonKodList>01,02,03,04</GyAzonKodList>
    </GyCsop>
</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/{ENUM}/{GyAzonKod}

Paraméter
   További header paraméterek nem szükségesek

Result
   XML - <GyCsop> : A gyűjtő csoportok adatai XML tömbként.

Hívá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>
        <GyAzonKod>01</GyAzonKod>
        <GyAzonNev>Központ</GyAzonNev>
        <!--A gyűjtő típustól függő további adatok-->
    </GyAzon>
</DbConnectorResponse>