Osoba

GET

/persons

Získá kolekci BO Osoba

GET

/persons/{id}

Získá konkrétní BO Osoba

POST

/persons

Vytvoří nový BO Osoba a vrátí jeho kompletní reprezentaci

PUT

/persons/{id}

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

DELETE

/persons/{id}

Smaže BO Osoba na základě jeho ID

Metadata - Perzistentní položky

Address_ID

pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

BirthNumber string (20)

Rodné číslo, 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

CRMMenuItem_ID string (crmmenuitem) relace

CRM zařazení; ID objektu CRM zařazení, 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

CommercialsAgreement integer

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

DateOfBirth$DATE string

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

FirstName string (20)

Jméno, 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

GDPRValiditySuspended boolean

Omezení zpracování (GDPR), 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, pole nepodporuje ochranu dat/GDPR

Grade string (60)

Popis pozice, 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

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

IDCardNumber string (20)

Číslo OP/pasu, 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

IsEmployee boolean

Zaměstnanec/Pracovník, pouze pro čtení, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu, pole nepodporuje ochranu dat/GDPR

IsOwned boolean

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

LastName string (30)

Příjmení, 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

Note string (0)

Poznámka, 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

ObjVersion integer

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

PersonalNumber string (10)

Osob.číslo, pole vlastněné tabulkou, možné řadit a filtrovat, pole nepodporuje ochranu dat/GDPR

Picture_ID

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

Pictures array (personpicture) relace

Obrázky; kolekce BO Obrázek k osobě, pole je duplikováno při klonování objektu, objekt na který pole odkazuje je 'vlastněn'

SalutationName string (30)

Jméno v 5. pádu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SalutationTitle string (30)

Oslovení, 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

Suffix string (20)

Titul za jménem, 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

Title string (20)

Titul, 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

Metadata - Neperzistentní položky

ClassID string (26)

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

Comment string (8191)

Poznámka

CommercialsAgreementDesc string (20)

Souhlas s reklamou - popis, pole nepodporuje ochranu dat/GDPR

DisplayName string (50)

Název, pouze pro čtení

FullName string (51)

Jméno + Příjmení, pouze pro čtení

ID string (10)

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

InsolvencyCheckResult integer

Stav insolvence, pole nepodporuje ochranu dat/GDPR

InsolvencyCheckResultAsText string (40)

Stav insolvence textově, pole nepodporuje ochranu dat/GDPR

InsolvencyLastCheckDateTime string

Datum a čas posledního ověření insolvence

InsolvencyLastCheckDateTime$DATE string

Datum a čas posledního ověření insolvence

LastAndFirstName string (51)

Příjmení + Jméno, pouze pro čtení

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

GET

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

GET

https://atd.abra.eu/demodata/persons/{id}
Response
{
    "ID": "2000000101",
    "ObjVersion": 8,
    "Hidden": false,
    "LastName": "Nejedlý",
    "FirstName": "Martin",
    "Title": "ing.",
    "Grade": "",
    "BirthNumber": "680821\/3335",
    "IDCardNumber": "378956789",
    "Note": "",
    "Address_ID": "ZC00000101",
    "IsEmployee": true,
    "IsOwned": true,
    "PersonalNumber": "001",
    "Picture_ID": null,
    "Suffix": "",
    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
    "GDPRValiditySuspended": false,
    "SalutationTitle": "",
    "SalutationName": "",
    "CommercialsAgreement": 0,
    "CRMMenuItem_ID": null,
    "Pictures": []
}
Request POST

POST

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

POST

https://atd.abra.eu/demodata/persons/query
{"take": "1"}
Response
{
    "ID": "2000000101",
    "ObjVersion": 8,
    "Hidden": false,
    "LastName": "Nejedlý",
    "FirstName": "Martin",
    "Title": "ing.",
    "Grade": "",
    "BirthNumber": "680821\/3335",
    "IDCardNumber": "378956789",
    "Note": "",
    "Address_ID": "ZC00000101",
    "IsEmployee": true,
    "IsOwned": true,
    "PersonalNumber": "001",
    "Picture_ID": null,
    "Suffix": "",
    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
    "GDPRValiditySuspended": false,
    "SalutationTitle": "",
    "SalutationName": "",
    "CommercialsAgreement": 0,
    "CRMMenuItem_ID": null,
    "Pictures": []
}
Request

POST

https://atd.abra.eu/demodata/persons?select=id
Body
{
    "BirthNumber": "680821\/3335",
    "CRMMenuItem_ID": null,
    "CommercialsAgreement": 0,
    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
    "FirstName": "Martin",
    "GDPRValiditySuspended": false,
    "Grade": "",
    "Hidden": false,
    "IDCardNumber": "378956789",
    "LastName": "Nejedlý",
    "Note": "",
    "PersonalNumber": "001",
    "Pictures": [],
    "SalutationName": "",
    "SalutationTitle": "",
    "Suffix": "",
    "Title": "ing."
}
Response
{
    "id": "2000000101"
}
Request

PUT

https://atd.abra.eu/demodata/persons/{id}?select=id
Body
{
    "BirthNumber": "680821\/3335",
    "CRMMenuItem_ID": null,
    "CommercialsAgreement": 0,
    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
    "FirstName": "Martin",
    "GDPRValiditySuspended": false,
    "Grade": "",
    "Hidden": false,
    "IDCardNumber": "378956789",
    "LastName": "Nejedlý",
    "Note": "",
    "PersonalNumber": "001",
    "Pictures": [],
    "SalutationName": "",
    "SalutationTitle": "",
    "Suffix": "",
    "Title": "ing."
}
Response
{
    "id": "2000000101"
}

DELETE

https://atd.abra.eu/demodata/persons/{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": "persons",
                "object_data": {
                    "BirthNumber": "680821\/3335",
                    "CRMMenuItem_ID": null,
                    "CommercialsAgreement": 0,
                    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
                    "FirstName": "Martin",
                    "GDPRValiditySuspended": false,
                    "Grade": "",
                    "Hidden": false,
                    "IDCardNumber": "378956789",
                    "LastName": "Nejedlý",
                    "Note": "",
                    "PersonalNumber": "001",
                    "Pictures": [],
                    "SalutationName": "",
                    "SalutationTitle": "",
                    "Suffix": "",
                    "Title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "persons",
                "object_data": {
                    "BirthNumber": "680821\/3335",
                    "CRMMenuItem_ID": null,
                    "CommercialsAgreement": 0,
                    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
                    "FirstName": "Martin",
                    "GDPRValiditySuspended": false,
                    "Grade": "",
                    "Hidden": false,
                    "IDCardNumber": "378956789",
                    "LastName": "Nejedlý",
                    "Note": "",
                    "PersonalNumber": "001",
                    "Pictures": [],
                    "SalutationName": "",
                    "SalutationTitle": "",
                    "Suffix": "",
                    "Title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000100",
                "object_data": {
                    "BirthNumber": "680821\/3335",
                    "CRMMenuItem_ID": null,
                    "CommercialsAgreement": 0,
                    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
                    "FirstName": "Martin",
                    "GDPRValiditySuspended": false,
                    "Grade": "",
                    "Hidden": false,
                    "IDCardNumber": "378956789",
                    "LastName": "Nejedlý",
                    "Note": "",
                    "PersonalNumber": "001",
                    "Pictures": [],
                    "SalutationName": "",
                    "SalutationTitle": "",
                    "Suffix": "",
                    "Title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000101",
                "object_data": {
                    "BirthNumber": "680821\/3335",
                    "CRMMenuItem_ID": null,
                    "CommercialsAgreement": 0,
                    "DateOfBirth$DATE": "1968-08-20T22:00:00.000Z",
                    "FirstName": "Martin",
                    "GDPRValiditySuspended": false,
                    "Grade": "",
                    "Hidden": false,
                    "IDCardNumber": "378956789",
                    "LastName": "Nejedlý",
                    "Note": "",
                    "PersonalNumber": "001",
                    "Pictures": [],
                    "SalutationName": "",
                    "SalutationTitle": "",
                    "Suffix": "",
                    "Title": "ing."
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "persons",
                "obj_id": "2000000104"
            }
        }
    ]
}