Pošta

GET

/postoffices

Získá kolekci BO Pošta

GET

/postoffices/{id}

Získá konkrétní BO Pošta

POST

/postoffices

Vytvoří nový BO Pošta a vrátí jeho kompletní reprezentaci

PUT

/postoffices/{id}

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

DELETE

/postoffices/{id}

Smaže BO Pošta na základě jeho ID

Metadata - Perzistentní položky

District_ID string (district) relace

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

Hidden boolean

Skrytý, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

ObjVersion integer

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

PostCode string (10)

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

PostName string (50)

Město/obec, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

RegionCode string (10)

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

RegionName string (50)

Název okresu, 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/postoffices?take=1

GET

https://atd.abra.eu/demodata/postoffices/{id}
Response
{
    "ID": "0010000000",
    "ObjVersion": 2,
    "Hidden": false,
    "PostCode": "100 00",
    "PostName": "Praha 10",
    "RegionCode": "3100",
    "RegionName": "Hlavní město Praha",
    "District_ID": "7700000000"
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/postoffices/query
{"take": "1"}
Response
{
    "ID": "0010000000",
    "ObjVersion": 2,
    "Hidden": false,
    "PostCode": "100 00",
    "PostName": "Praha 10",
    "RegionCode": "3100",
    "RegionName": "Hlavní město Praha",
    "District_ID": "7700000000"
}
Request

POST

https://atd.abra.eu/demodata/postoffices?select=id
Body
{
    "District_ID": "7700000000",
    "Hidden": false,
    "PostCode": "100 00",
    "PostName": "Praha 10",
    "RegionCode": "3100",
    "RegionName": "Hlavní město Praha"
}
Response
{
    "id": "0010000000"
}
Request

PUT

https://atd.abra.eu/demodata/postoffices/{id}?select=id
Body
{
    "District_ID": "7700000000",
    "Hidden": false,
    "PostCode": "100 00",
    "PostName": "Praha 10",
    "RegionCode": "3100",
    "RegionName": "Hlavní město Praha"
}
Response
{
    "id": "0010000000"
}

DELETE

https://atd.abra.eu/demodata/postoffices/{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": "postoffices",
                "object_data": {
                    "District_ID": "7700000000",
                    "Hidden": false,
                    "PostCode": "100 00",
                    "PostName": "Praha 10",
                    "RegionCode": "3100",
                    "RegionName": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "postoffices",
                "object_data": {
                    "District_ID": "7700000000",
                    "Hidden": false,
                    "PostCode": "100 00",
                    "PostName": "Praha 10",
                    "RegionCode": "3100",
                    "RegionName": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000000",
                "object_data": {
                    "District_ID": "7700000000",
                    "Hidden": false,
                    "PostCode": "100 00",
                    "PostName": "Praha 10",
                    "RegionCode": "3100",
                    "RegionName": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000001",
                "object_data": {
                    "District_ID": "7700000000",
                    "Hidden": false,
                    "PostCode": "100 00",
                    "PostName": "Praha 10",
                    "RegionCode": "3100",
                    "RegionName": "Hlavní město Praha"
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000000"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000001"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000002"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000003"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "postoffices",
                "obj_id": "0010000004"
            }
        }
    ]
}