Traffic Regulation API V1 (REST)

REST API

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

Find traffic regulation classes

Forgalomszabályozási osztályok keresése.

REST API

Kérés

GET hammy/json/trafficregulation/v1/classes

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.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JTrafficRegulationClass1 [ ]	A keresett osztályok.

Minta

KérésVálasz

GET /json/trafficregulation/v1/classes
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

Query params:
-------------------------
limit={{}}
offset={{}}


GET /json/trafficregulation/v1/classes?limit=10&offset=0

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

{
  "data": [
    {
      "type": "trafficRegulationClasses",
      "id": "644585fc-2cdb-463e-8c04-7e44da51db52",
      "attributes": {
        "code": "CLASS01",
        "description": "Ez itt a leírás",
        "active": true,
        "createdAt": "2020-11-24T22:31:54.978+0100",
        "updatedAt": "2020-11-24T22:31:54.978+0100"
      },
      "relationships": {
        "rules": {
          "data": [
            {
              "type": "trafficRegulationRules",
              "id": "300ec7c2-65e4-4f95-af33-85609c112979"
            }
          ]
        }
      }
    },
    {
      "type": "trafficRegulationClasses",
      "id": "644585fc-2cdb-463e-8c04-7e44da51db11",
      "attributes": {
        "code": "CLASS02",
        "description": "Ez itt a leírás 3",
        "active": true,
        "createdAt": "2020-11-25T12:18:40.738+0100",
        "updatedAt": "2020-11-25T20:00:49.986+0100"
      },
      "relationships": {
        "rules": {
          "data": [
            {
              "type": "trafficRegulationRules",
              "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9e"
            },
            {
              "type": "trafficRegulationRules",
              "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9f"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "trafficRegulationRules",
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9e",
      "attributes": {
        "enabledFrom": "14:15",
        "enabledTo": "06:00",
        "active": true,
        "createdAt": "2020-11-25T19:56:32.919+0100",
        "updatedAt": "2020-11-25T19:56:32.919+0100"
      }
    },
    {
      "type": "trafficRegulationRules",
      "id": "300ec7c2-65e4-4f95-af33-85609c112979",
      "attributes": {
        "enabledFrom": "10:30",
        "enabledTo": "15:10",
        "active": true,
        "createdAt": "2020-11-26T10:54:52.492+0100",
        "updatedAt": "2020-11-26T10:54:55.654+0100"
      }
    },
    {
      "type": "trafficRegulationRules",
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9f",
      "attributes": {
        "enabledFrom": "09:15",
        "enabledTo": "13:00",
        "limitPerHour": 200,
        "active": true,
        "createdAt": "2020-11-25T19:56:32.917+0100",
        "updatedAt": "2020-11-25T19:56:32.917+0100"
      }
    }
  ],
  "meta": {
    "total": 2,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Show traffic regulation class

Forgalomszabályozási osztály lekérése.

REST API

REST API Info

Kérés

GET hammy/json/trafficregulation/v1/classes/{{uuid}}

Név	Típus	Leírás
uuid	String	Az osztály UUID-ja.

Válasz

Típus	Leírás
JTrafficRegulationClass1	A keresett osztály.

Minta

KérésVálasz

GET /json/trafficregulation/v1/classes/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

GET /json/trafficregulation/v1/classes/644585fc-2cdb-463e-8c04-7e44da51db11

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

{
  "data": {
    "type": "trafficRegulationClasses",
    "id": "644585fc-2cdb-463e-8c04-7e44da51db11",
    "attributes": {
      "code": "CLASS02",
      "description": "Ez itt a leírás 2",
      "active": true,
      "createdAt": "2020-11-26T16:06:24.843+0100",
      "updatedAt": "2020-11-26T16:06:24.843+0100"
    },
    "relationships": {
      "rules": {
        "data": [
          {
            "type": "trafficRegulationRules",
            "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "trafficRegulationRules",
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
      "attributes": {
        "enabledFrom": "11:15",
        "enabledTo": "12:00",
        "limitPerHour": 200,
        "active": true,
        "createdAt": "2020-11-26T16:06:24.853+0100",
        "updatedAt": "2020-11-26T16:06:24.853+0100"
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create traffic regulation class

Forgalomszabályozási osztály létrehozása.

REST API

REST API Info

Kérés

POST hammy/json/trafficregulation/v1/classes

body: JTrafficRegulationClass1

Válasz

Típus	Leírás
JTrafficRegulationClass1	A létrehozott osztály.

Minta

KérésVálasz

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

{
  "data": {
    "type": "trafficRegulationClasses",
    "id": "644585fc-2cdb-463e-8c04-7e44da51db11",
    "attributes": {
      "code": "CLASS02",
      "description": "Ez itt a leírás 2",
      "active": "true"
    },
    "relationships": {
      "rules": {
        "data": [{
          "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
          "type": "trafficRegulationRules"
        }]
      }
    }
  },
  "included": [
    {
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
      "attributes": {
        "enabledFrom": "11:15",
        "enabledTo": "12:00",
        "limitPerHour": 200,
        "active": true
      },
      "type": "trafficRegulationRules"
    }
  ]
}

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

{
  "data": {
    "type": "trafficRegulationClasses",
    "id": "644585fc-2cdb-463e-8c04-7e44da51db11",
    "attributes": {
      "code": "CLASS02",
      "description": "Ez itt a leírás 2",
      "active": true,
      "createdAt": "2020-11-26T16:06:24.843+0100",
      "updatedAt": "2020-11-26T16:06:24.843+0100"
    },
    "relationships": {
      "rules": {
        "data": [
          {
            "type": "trafficRegulationRules",
            "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "trafficRegulationRules",
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
      "attributes": {
        "enabledFrom": "11:15",
        "enabledTo": "12:00",
        "limitPerHour": 200,
        "active": true,
        "createdAt": "2020-11-26T16:06:24.853+0100",
        "updatedAt": "2020-11-26T16:06:24.853+0100"
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Update traffic regulation class

Forgalomszabályozási osztály módosítása.

REST API

REST API Info

Kérés

PUT hammy/json/trafficregulation/v1/classes/{{uuid}}

body: JTrafficRegulationClass1

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

Válasz

Típus	Leírás
JTrafficRegulationClass1	A módosított osztály.

Minta

KérésVálasz

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

{
  "data": {
    "type": "trafficRegulationClasses",
    "id": "644585fc-2cdb-463e-8c04-7e44da51db11",
    "attributes": {
      "code": "CLASS02",
      "description": "Ez itt a leírás 2",
      "active": "true"
    },
    "relationships": {
      "rules": {
        "data": [{
          "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
          "type": "trafficRegulationRules"
        }]
      }
    }
  },
  "included": [
    {
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
      "attributes": {
        "enabledFrom": "11:15",
        "enabledTo": "12:00",
        "limitPerHour": 200,
        "active": true
      },
      "type": "trafficRegulationRules"
    }
  ]
}

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

{
  "data": {
    "type": "trafficRegulationClasses",
    "id": "644585fc-2cdb-463e-8c04-7e44da51db11",
    "attributes": {
      "code": "CLASS02",
      "description": "Ez itt a leírás 2",
      "active": true,
      "createdAt": "2020-11-26T16:06:24.843+0100",
      "updatedAt": "2020-11-26T16:06:24.843+0100"
    },
    "relationships": {
      "rules": {
        "data": [
          {
            "type": "trafficRegulationRules",
            "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "trafficRegulationRules",
      "id": "fb3ba65e-f5ec-4c31-828c-f8bda357aa9d",
      "attributes": {
        "enabledFrom": "11:15",
        "enabledTo": "12:00",
        "limitPerHour": 200,
        "active": true,
        "createdAt": "2020-11-26T16:06:24.853+0100",
        "updatedAt": "2020-11-26T16:06:24.853+0100"
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Delete traffic regulation class

Forgalomszabályozási osztály törlése.

REST API

REST API Info

Kérés

DELETE hammy/json/trafficregulation/v1/classes/{{uuid}}

Név	Típus	Leírás
uuid	String	A törlendő osztály UUID-ja.

Válasz

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

Minta

KérésVálasz

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

DELETE /json/trafficregulation/v1/classes/644585fc-2cdb-463e-8c04-7e44da51db11

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

{
  "data": {
    "type": "emptyResponse",
    "id": "ea304ec3-6135-4d05-a473-652f695c0d9d",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}