Adresa

GET

/addresses

Získá kolekci BO Adresa

GET

/addresses/meta/dataprotection

Získá seznam položek BO, které mohou být chráněny na BO Adresa

GET

/addresses/views/{view}

Získá pohled nad BO Adresa

GET

/addresses/{id}

Získá daný BO Adresa

GET

/addresses/{id}/iseditlock

Otestuje, zda existuje editační zámek na daném BO Adresa

GET

/addresses/{id}/meta/dataprotection

Získá seznam chráněných položek, které jsou na BO Adresa aktuálnímu uživateli znepřístupněny

GET

/addresses/{id}/userparameters

Získá seznam uživatelských parametrů včetně jejich hodnot k danému BO Adresa

POST

/addresses

Vytvoří nový BO Adresa

POST

/addresses/query

Vyhodnotí query dotaz nad BO Adresa

POST

/addresses/import/addresses

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do nového cílového dokladu

POST

/addresses/import/addresses/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do nového cílového dokladu

PUT

/addresses/{id}

Modifikuje daný BO Adresa

PUT

/addresses/{id}/editlock

Vytvoří editační zámek na daném BO Adresa

PUT

/addresses/{id}/editunlock

Zruší editační zámek na daném BO Adresa

PUT

/addresses/{dest_doc_id}/import/addresses

ZASTARALÉ! Provede import v těle specifikovaných zdrojových dokladů do již existujícího cílového dokladu

PUT

/addresses/{dest_doc_id}/import/addresses/{source_doc_id}

ZASTARALÉ! Provede import v url specifikovaného zdrojového dokladu do již existujícího cílového dokladu

DELETE

/addresses/{id}

Smaže BO Adresa

Metadata - Perzistentní položky

city string (60)

Město, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole je přístupná pro hromadné změny

country string (40)

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

countrycode string (3)

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

databox string (20)

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

email string (320)

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

faxnumber string (30)

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

gln string (30)

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

gps string (40)

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

location string (60)

Oddělení, 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

phonenumber1 string (30)

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

phonenumber2 string (30)

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

postcode string (10)

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

recipient string (30)

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

street string (60)

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

zip string (20)

ZIP kód, 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

officialcity string (50)

Úřední město, pouze pro čtení

officialhousenumber string (50)

Úřední domovní číslo, pouze pro čtení

officialstreet string (50)

Úřední ulice, pouze pro čtení

shortaddress string (50)

Adresa, pouze pro čtení

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/addresses?take=1
GET
https://atd.abra.eu/demodata/addresses/{id}
Response 
{
    "objversion": 1,
    "recipient": "",
    "city": "",
    "street": "",
    "postcode": "",
    "zip": "",
    "country": "",
    "phonenumber1": "",
    "phonenumber2": "",
    "faxnumber": "",
    "email": "",
    "location": "",
    "countrycode": "",
    "gps": "",
    "databox": "",
    "gln": ""
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "addresses", "take": "1"}
POST
https://atd.abra.eu/demodata/addresses/query
{"take": "1"}
Response 
{
    "objversion": 1,
    "recipient": "",
    "city": "",
    "street": "",
    "postcode": "",
    "zip": "",
    "country": "",
    "phonenumber1": "",
    "phonenumber2": "",
    "faxnumber": "",
    "email": "",
    "location": "",
    "countrycode": "",
    "gps": "",
    "databox": "",
    "gln": ""
}
Request 
POST
https://atd.abra.eu/demodata/addresses?select=id
Body 
{
    "city": "",
    "country": "",
    "countrycode": "",
    "databox": "",
    "email": "",
    "faxnumber": "",
    "gln": "",
    "gps": "",
    "location": "",
    "phonenumber1": "",
    "phonenumber2": "",
    "postcode": "",
    "recipient": "",
    "street": "",
    "zip": ""
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/addresses/{id}?select=id
Body 
{
    "city": "",
    "country": "",
    "countrycode": "",
    "databox": "",
    "email": "",
    "faxnumber": "",
    "gln": "",
    "gps": "",
    "location": "",
    "phonenumber1": "",
    "phonenumber2": "",
    "postcode": "",
    "recipient": "",
    "street": "",
    "zip": ""
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/addresses/{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": "addresses",
                "object_data": {
                    "city": "",
                    "country": "",
                    "countrycode": "",
                    "databox": "",
                    "email": "",
                    "faxnumber": "",
                    "gln": "",
                    "gps": "",
                    "location": "",
                    "phonenumber1": "",
                    "phonenumber2": "",
                    "postcode": "",
                    "recipient": "",
                    "street": "",
                    "zip": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "addresses",
                "object_data": {
                    "city": "",
                    "country": "",
                    "countrycode": "",
                    "databox": "",
                    "email": "",
                    "faxnumber": "",
                    "gln": "",
                    "gps": "",
                    "location": "",
                    "phonenumber1": "",
                    "phonenumber2": "",
                    "postcode": "",
                    "recipient": "",
                    "street": "",
                    "zip": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000100",
                "object_data": {
                    "city": "",
                    "country": "",
                    "countrycode": "",
                    "databox": "",
                    "email": "",
                    "faxnumber": "",
                    "gln": "",
                    "gps": "",
                    "location": "",
                    "phonenumber1": "",
                    "phonenumber2": "",
                    "postcode": "",
                    "recipient": "",
                    "street": "",
                    "zip": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000101",
                "object_data": {
                    "city": "",
                    "country": "",
                    "countrycode": "",
                    "databox": "",
                    "email": "",
                    "faxnumber": "",
                    "gln": "",
                    "gps": "",
                    "location": "",
                    "phonenumber1": "",
                    "phonenumber2": "",
                    "postcode": "",
                    "recipient": "",
                    "street": "",
                    "zip": ""
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "addresses",
                "obj_id": "1600000104"
            }
        }
    ]
}