Druhy pojištěnců státu

GET

/hipaysgovernmenttypes

Získá kolekci BO Druhy pojištěnců státu

GET

/hipaysgovernmenttypes/{id}

Získá konkrétní BO Druhy pojištěnců státu

POST

/hipaysgovernmenttypes

Vytvoří nový BO Druhy pojištěnců státu a vrátí jeho kompletní reprezentaci

PUT

/hipaysgovernmenttypes/{id}

Provede aktualizaci BO Druhy pojištěnců státu a vrátí jeho kompletní, aktualizovanou reprezentaci. Operaci PUT je možné využívat i k částečným aktualizacím zdrojů (PATCH).

DELETE

/hipaysgovernmenttypes/{id}

Smaže BO Druhy pojištěnců státu na základě jeho ID

Metadata - Perzistentní položky

Code string (10)

Kód, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

EndCode string (10)

Kód ukončení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Name string (200)

Název, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

ObjVersion integer

Verze objektu, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

StartCode string (10)

Kód začátku, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

Metadata - Neperzistentní položky

ClassID string (26)

ID třídy, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

DisplayName string (100)

Název, pouze pro čtení

ID string (10)

Vlastní ID, pouze pro čtení, fkAnsiCaseSensitive, pole nepodporuje ochranu dat/GDPR

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request

GET

https://atd.abra.eu/demodata/hipaysgovernmenttypes?take=1

GET

https://atd.abra.eu/demodata/hipaysgovernmenttypes/{id}
Response
{
    "ID": "1000000000",
    "ObjVersion": 1,
    "Code": "Student",
    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
    "StartCode": "G",
    "EndCode": "F"
}
Request POST

POST

https://atd.abra.eu/demodata/query
{"class": "hipaysgovernmenttypes", "take": "1"}

POST

https://atd.abra.eu/demodata/hipaysgovernmenttypes/query
{"take": "1"}
Response
{
    "ID": "1000000000",
    "ObjVersion": 1,
    "Code": "Student",
    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
    "StartCode": "G",
    "EndCode": "F"
}
Request

POST

https://atd.abra.eu/demodata/hipaysgovernmenttypes?select=id
Body
{
    "Code": "Student",
    "EndCode": "F",
    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
    "StartCode": "G"
}
Response
{
    "id": "1000000000"
}
Request

PUT

https://atd.abra.eu/demodata/hipaysgovernmenttypes/{id}?select=id
Body
{
    "Code": "Student",
    "EndCode": "F",
    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
    "StartCode": "G"
}
Response
{
    "id": "1000000000"
}

DELETE

https://atd.abra.eu/demodata/hipaysgovernmenttypes/{id}
Response
200 - OK Everything worked as expected.
Dávkové zprocování záznamů Request

PUT

https://atd.abra.eu/demodata//batch
  • CREATE
  • UPDATE
  • DELETE
Body - Create
{
    "items": [
        {
            "type": "create",
            "id": "id0",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "object_data": {
                    "Code": "Student",
                    "EndCode": "F",
                    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
                    "StartCode": "G"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "object_data": {
                    "Code": "Student",
                    "EndCode": "F",
                    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
                    "StartCode": "G"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000000",
                "object_data": {
                    "Code": "Student",
                    "EndCode": "F",
                    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
                    "StartCode": "G"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000001",
                "object_data": {
                    "Code": "Student",
                    "EndCode": "F",
                    "Name": "Student - § 7 odst. 1a) zákona 48\/1997 Sb.",
                    "StartCode": "G"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000000"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000001"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000002"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000003"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "hipaysgovernmenttypes",
                "obj_id": "1000000004"
            }
        }
    ]
}