Code table API V1

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

Find code tables

Kódtábla elemek listázása.

REST API

Kérés

GET hammy/json/codetable/v1/codetables

Paraméter	Típus	Leírás
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete.
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.
language	String	A kódtábla nyelve.
types	String [ ]	A kódtáblák típusai.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JCodeTable1 [ ]	A megtalált kódtáblák.

Minta

KérésVálasz

GET /hammy/json/codetable/v1/codetables
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

Query params:
-------------------------
language={{Nyelv kódja. Két karakteres ISO 3166 szabvány szerint.}}
types={{kódtábla rekord típusa. Listás kereső elem.}}

limit={{}}
offset={{}}

/hammy/json/codetable/v1/codetables?types%5B%5D=CLIENT_OS_NAME&language=HU

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "codetables",
      "id": "3e344fb4-a9ea-4210-b14c-5457d6d165e7",
      "attributes": {
        "type": "CLIENT_OS_NAME",
        "value": "FEDORA",
        "label": "Fedora",
        "language": "HU"
      }
    },
    {
      "type": "codetables",
      "id": "2b688f43-7eb8-45d4-857d-5c7b3ca260d4",
      "attributes": {
        "type": "CLIENT_OS_NAME",
        "value": "MAC_OS_X",
        "label": "Mac OS X",
        "language": "HU"
      }
    }
  ],
  "meta": {
    "total": 2,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create code table

Új kódtábla rekord létrehozása.

REST API

REST API Info

Kérés

POST hammy/json/codetable/v1/codetables

body: JCodeTable1

Válasz

Típus	Leírás
JCodeTable1	A létrehozott kódtábla.

Minta

KérésVálasz

POST /hammy/json/codetable/v1/codetables
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "codetables",
        "attributes": {
            "type": "CLIENT_DEVICE_CLASS",
            "value": "TABLET",
            "label": "Tablet",
            "language" : "HU"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "codetables",
        "id": "e5f83e63-8290-4caf-8790-f86179f7c2b2",
        "attributes": {
            "type": "CLIENT_DEVICE_CLASS",
            "value": "TABLET",
            "label": "Tablet",
            "language": "HU"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Modify code table

Kódtábla rekord módosítása.

REST API

REST API Info

Kérés

PUT hammy/json/codetable/v1/codetables/{{uuid}}

body: JCodeTable1

path

Név	Típus	Leírás
uuid	String	A módosítandó kódtábla UUID-ja.

Válasz

Típus	Leírás
JCodeTable1	A módosított kódtábla.

Minta

KérésVálasz

PUT /hammy/json/codetable/v1/codetables/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "codetables",
        "attributes": {
            "type": "CLIENT_DEVICE_CLASS",
            "value": "TABLET",
            "label": "Tablet",
            "language" : "HU"
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "codetables",
        "id": "e5f83e63-8290-4caf-8790-f86179f7c2b2",
        "attributes": {
            "type": "CLIENT_DEVICE_CLASS",
            "value": "TABLET",
            "label": "Tablet",
            "language": "HU"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Delete code table

Kódtábla törlése.

REST API

REST API Info

Kérés

DELETE hammy/json/codetable/v1/codetables/{{uuid}}

path

Név	Típus	Leírás
uuid	String	A törlendő kódtábla UUID-ja.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

Minta

KérésVálasz

DELETE /json/codetable/v1/codetables/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

DELETE /json/codetable/v1/codetables/c16423a1-3b86-48d4-89b6-6d67a83a91f6

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "emptyResponse",
    "id": "2241fd4c-44bf-45df-a713-55e0e7306e87",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}