Közös típusok
JRequestMeta_V1
| Név | Típus | Leírás |
|---|---|---|
| clientHashKey | String | A szolgáltatást hívó kliens azonosítója. |
| userName | String | Felhasználó neve. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
JMeta1
| Név | Típus | Leírás |
|---|---|---|
| responseStatus | ResponseStatus_V1 | Válasz státusza. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
ResponseStatus_V1
| Név | Típus | Leírás |
|---|---|---|
| code | Integer | Státusz kód. |
| messages | Message_V1 [ ] | Üzenetek listája. |
Param_V1
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| key | String | Kulcs mező. | * |
| value | String | Érték. | * |
| ref | String | Referencia. |
Message_V1
| Név | Típus | Leírás |
|---|---|---|
| severity | Severity | Az üzenet súlyossága. |
| code | Code | Az üzenet kódja. |
| description | String | Az üzenet szövege. |
| refElement | String | Referencia az adott elemre. |
| refValue | String | Az üzenetet kiváltó mező értéke. |
Code
| Érték | Leírás |
|---|---|
| 0 | Sikeres kérés. |
| 1 | Technikai hiba. |
| 2 | Validációs hiba. |
Severity
| Érték | Jelentés |
|---|---|
| ERROR | Hiba (technikai status = 1, vagy validációs: status = 2). |
| WARNING | Figyelmeztetés szintű üzenet. |
| INFO | Tájékoztató üzenet. |
RequestMeta_V1
| Név | Típus | Leírás |
|---|---|---|
| clientHashKey | String | A szolgáltatást hívó kliens azonosítója. |
| userName | String | Felhasználó neve. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
CGErrorType_V1
| Név | Típus | Leírás |
|---|---|---|
| id | Integer | A hiba típus azonosítója. |
| errorName | String | A hiba típus neve. |
| errorClass | String | A hiba típus osztálya. |
| errorType | String | A hiba típus fajtája. Lehetséges értékek: F, E, W. |
| errorHandlingCategory | Integer | A hiba kezelő kategória azonosítója. |
| errorMessage | String | Hibaüzenet. |
JCGErrorType_V1
vnd.api type: errorType
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | A híváshoz tartozó metaadatok. |
| id | Integer | A hiba típus azonosítója. (vnd.api ID) |
| errorName | String | A hiba típus neve. |
| errorClass | String | A hiba típus osztálya. |
| errorType | String | A hiba típus fajtája. Lehetséges értékek: F, E, W. |
| errorHandlingCategory | Integer | A hiba kezelő kategória azonosítója. |
| errorMessage | String | Hibaüzenet. |
JCGErrorType_V2
vnd.api type: errorTypes
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | A híváshoz tartozó metaadatok. |
| id | Integer | A hiba típus azonosítója. (vnd.api ID) |
| errorName | String | A hiba típus neve. |
| errorClass | String | A hiba típus osztálya. |
| errorType | String | A hiba típus fajtája. Lehetséges értékek: F, E, W. |
| errorHandlingCategory | Integer | A hiba kezelő kategória azonosítója. |
| errorMessage | String | Hibaüzenet. |
CGParam_V1
vnd.api type: parameter
| Név | Típus | Leírás |
|---|---|---|
| id | Integer | Elsődleges azonosító. (vnd.api ID) |
| key | String | A paramétert azonosító kulcs. |
| value | String | A paraméter értéke. |
| objectType | String | A paraméter hatókör típusa. |
| objectId | String | A paraméter hatókör azonosítója. |
| kind | String | A paraméter fajtája. |
CGParam_V2
| Név | Típus | Leírás |
|---|---|---|
| id | Integer | Elsődleges azonosító. |
| key | String | A paramétert azonosító kulcs. |
| value | String | A paraméter értéke. |
| objectType | String | A paraméter hatókör típusa. |
| objectId | String | A paraméter hatókör azonosítója. |
| uuid | String | A paraméter UUID-ja. |
JCGParamWithSubParams_V1
vnd.api type: paramWithSubParams
| Név | Típus | Leírás |
|---|---|---|
| id | Integer | Elsődleges azonosító. (vnd.api ID) |
| key | String | A paramétert azonosító kulcs. |
| value | String | A paraméter értéke. |
| objectType | String | A paraméter hatókör típusa. |
| objectId | String | A paraméter hatókör azonosítója. |
| kind | String | A paraméter fajtája. |
| subParams | JCGParamWithSubParams_V1 [ ] | Alparaméterek. |
JListMeta1
| Név | Típus | Leírás |
|---|---|---|
| total | Integer | A lista elemszáma. |
| responseStatus | ResponseStatus_V1 | Válasz státusza. |
| params | Param_V1 [ ] | Egyéb paraméterek listája. |
Order_V1
| Név | Típus | Leírás |
|---|---|---|
| fieldName | String | A rendezendő mező. |
| direction | Direction_V1 | Rendezés iránya. |
Direction_V1
| Érték | Jelentés |
|---|---|
| ASCENDING | Növekvő sorrend. |
| DESCENDING | Csökkenő sorrend. |
Order
| Név | Típus | Leírás |
|---|---|---|
| aliasName | String | JOIN esetén táblanév alias. |
| fieldName | String | A rendezendő mező. |
| direction | Direction_V1 | Rendezés iránya. |
ErrorHandlingCategory1
| Mező | Típus | Leírás |
|---|---|---|
| failureLimitPerMin | Integer | Maximum megengedett hiba/perc. |
| id | Integer | Hiba kezelési azonosító. (vnd.api ID) |
| name | Sting | Hiba neve |
| responsibles | String | Felelős. |
| punishmentMins | Integer | Büntetés |
Utoljára frissítve
