Doručená datová zpráva

GET

/databoxmessreceiveds

Získá kolekci BO Doručená datová zpráva

GET

/databoxmessreceiveds/{id}

Získá konkrétní BO Doručená datová zpráva

POST

/databoxmessreceiveds

Vytvoří nový BO Doručená datová zpráva a vrátí jeho kompletní reprezentaci

PUT

/databoxmessreceiveds/{id}

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

DELETE

/databoxmessreceiveds/{id}

Smaže BO Doručená datová zpráva na základě jeho ID

Metadata - Perzistentní položky

AmbiguousRecipient boolean

Adresát je ne-OVM povýšený na OVM, pole vlastněné tabulkou, možné řadit a filtrovat

AuthorName string (100)

Odesílající osoba, pole vlastněné tabulkou, možné řadit a filtrovat

AuthorUserType integer

Typ odesílající osoby, pole vlastněné tabulkou, možné řadit a filtrovat

DmType integer

Typ datové zprávy, pole vlastněné tabulkou, možné řadit a filtrovat

IDRecipient string (7)

ID datové schránky příjemce, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

IDSender string (7)

ID datové schránky odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

LegalTitleLaw integer

Zmocnění - číslo zákona, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

LegalTitlePar string (2)

Zmocnění - odstavec v paragrafu, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

LegalTitlePoint string (2)

Zmocnění - písmeno v odstavci, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

LegalTitleSect string (20)

Zmocnění - paragraf v zákoně, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

LegalTitleYear integer

Zmocnění - rok vydání zákona, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

MessageStatus integer

Stav datové zprávy, pole vlastněné tabulkou, možné řadit a filtrovat

ObjVersion integer

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

Owner_ID string (10)

Identifikace vlastníka datové zprávy, pole vlastněné tabulkou, možné řadit a filtrovat, fkAnsiCaseSensitive

PersonalDelivery boolean

Příznak do vlastních rukou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

QTimestamp string

Kvalifikované časové razítko, pole vlastněné tabulkou, možné řadit a filtrovat

Recipient string (100)

Příjemce slovně, pole vlastněné tabulkou, možné řadit a filtrovat

RecipientAddress string (100)

Poštovní adresa příjemce, pole vlastněné tabulkou, možné řadit a filtrovat

RecipientIdent string (50)

Spisová značka ze strany příjemce, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

RecipientOrgUnit string (100)

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

RecipientOrgUnitNum integer

Organizační jednotka příjemce hodnotou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

RecipientRefNumber string (50)

Číslo jednací za strany příjemce, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

RestrictionDeliveryFiction boolean

Zákaz doručení fikcí, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SenderAddress string (100)

Poštovní adresa odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

SenderIdent string (50)

Spisová značka a strany odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SenderOrgUnit string (100)

Organizační jednotka odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SenderOrgUnitNum integer

Organizační jednotka odesílatele hodnotou, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SenderRefNumber string (50)

Číslo jednací za strany odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat, pole je duplikováno při klonování objektu

SenderType integer

Typ schránky odesílatele, pole vlastněné tabulkou, možné řadit a filtrovat

SignedDeliveryInfo_ID

pole vlastněné tabulkou, možné řadit a filtrovat, objekt na který pole odkazuje je 'vlastněn'

SignedMessage_ID

pole vlastněné tabulkou, možné řadit a filtrovat, objekt na který pole odkazuje je 'vlastněn'

ToHands string (50)

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

Metadata - Neperzistentní položky

AuthorText string (130)

Odesílatel zprávy, pouze pro čtení

ClassID string (26)

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

DisplayName string (100)

Název, pouze pro čtení

DmTypeText string (100)

Název typu datové zprávy, pouze pro čtení

ID string (10)

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

MessageStatusText string (100)

Stav datové zprávy textově

SenderTypeText string (40)

Typ schránky odesílatele textově

SignedDeliveryInfoLoaded boolean

Obsah doručenky stažen

SignedMessageLoaded boolean

Obsah zprávy stažen

Příklady
  • GET
  • QUERY
  • POST
  • PUT
  • DELETE
  • BATCH
  • Builder
Request 
GET
https://atd.abra.eu/demodata/databoxmessreceiveds?take=1
GET
https://atd.abra.eu/demodata/databoxmessreceiveds/{id}
Response 
{
    "AmbiguousRecipient": null,
    "AuthorName": null,
    "AuthorUserType": null,
    "DmType": null,
    "ID": null,
    "IDRecipient": null,
    "IDSender": null,
    "LegalTitleLaw": null,
    "LegalTitlePar": null,
    "LegalTitlePoint": null,
    "LegalTitleSect": null,
    "LegalTitleYear": null,
    "MessageStatus": null,
    "ObjVersion": null,
    "Owner_ID": null,
    "PersonalDelivery": null,
    "QTimestamp": null,
    "Recipient": null,
    "RecipientAddress": null,
    "RecipientIdent": null,
    "RecipientOrgUnit": null,
    "RecipientOrgUnitNum": null,
    "RecipientRefNumber": null,
    "RestrictionDeliveryFiction": null,
    "SenderAddress": null,
    "SenderIdent": null,
    "SenderOrgUnit": null,
    "SenderOrgUnitNum": null,
    "SenderRefNumber": null,
    "SenderType": null,
    "SignedDeliveryInfo_ID": null,
    "SignedMessage_ID": null,
    "ToHands": null
}
Request POST 
POST
https://atd.abra.eu/demodata/query
{"class": "databoxmessreceiveds", "take": "1"}
POST
https://atd.abra.eu/demodata/databoxmessreceiveds/query
{"take": "1"}
Response 
{
    "AmbiguousRecipient": null,
    "AuthorName": null,
    "AuthorUserType": null,
    "DmType": null,
    "ID": null,
    "IDRecipient": null,
    "IDSender": null,
    "LegalTitleLaw": null,
    "LegalTitlePar": null,
    "LegalTitlePoint": null,
    "LegalTitleSect": null,
    "LegalTitleYear": null,
    "MessageStatus": null,
    "ObjVersion": null,
    "Owner_ID": null,
    "PersonalDelivery": null,
    "QTimestamp": null,
    "Recipient": null,
    "RecipientAddress": null,
    "RecipientIdent": null,
    "RecipientOrgUnit": null,
    "RecipientOrgUnitNum": null,
    "RecipientRefNumber": null,
    "RestrictionDeliveryFiction": null,
    "SenderAddress": null,
    "SenderIdent": null,
    "SenderOrgUnit": null,
    "SenderOrgUnitNum": null,
    "SenderRefNumber": null,
    "SenderType": null,
    "SignedDeliveryInfo_ID": null,
    "SignedMessage_ID": null,
    "ToHands": null
}
Request 
POST
https://atd.abra.eu/demodata/databoxmessreceiveds?select=id
Body 
{
    "AmbiguousRecipient": null,
    "AuthorName": null,
    "AuthorUserType": null,
    "DmType": null,
    "IDRecipient": null,
    "IDSender": null,
    "LegalTitleLaw": null,
    "LegalTitlePar": null,
    "LegalTitlePoint": null,
    "LegalTitleSect": null,
    "LegalTitleYear": null,
    "MessageStatus": null,
    "Owner_ID": null,
    "PersonalDelivery": null,
    "QTimestamp": null,
    "Recipient": null,
    "RecipientAddress": null,
    "RecipientIdent": null,
    "RecipientOrgUnit": null,
    "RecipientOrgUnitNum": null,
    "RecipientRefNumber": null,
    "RestrictionDeliveryFiction": null,
    "SenderAddress": null,
    "SenderIdent": null,
    "SenderOrgUnit": null,
    "SenderOrgUnitNum": null,
    "SenderRefNumber": null,
    "SenderType": null,
    "ToHands": null
}
Response 
{
    "id": "1600000101"
}
Request 
PUT
https://atd.abra.eu/demodata/databoxmessreceiveds/{id}?select=id
Body 
{
    "AmbiguousRecipient": null,
    "AuthorName": null,
    "AuthorUserType": null,
    "DmType": null,
    "IDRecipient": null,
    "IDSender": null,
    "LegalTitleLaw": null,
    "LegalTitlePar": null,
    "LegalTitlePoint": null,
    "LegalTitleSect": null,
    "LegalTitleYear": null,
    "MessageStatus": null,
    "Owner_ID": null,
    "PersonalDelivery": null,
    "QTimestamp": null,
    "Recipient": null,
    "RecipientAddress": null,
    "RecipientIdent": null,
    "RecipientOrgUnit": null,
    "RecipientOrgUnitNum": null,
    "RecipientRefNumber": null,
    "RestrictionDeliveryFiction": null,
    "SenderAddress": null,
    "SenderIdent": null,
    "SenderOrgUnit": null,
    "SenderOrgUnitNum": null,
    "SenderRefNumber": null,
    "SenderType": null,
    "ToHands": null
}
Response 
{
    "id": "1600000101"
}
DELETE
https://atd.abra.eu/demodata/databoxmessreceiveds/{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": "databoxmessreceiveds",
                "object_data": {
                    "AmbiguousRecipient": null,
                    "AuthorName": null,
                    "AuthorUserType": null,
                    "DmType": null,
                    "IDRecipient": null,
                    "IDSender": null,
                    "LegalTitleLaw": null,
                    "LegalTitlePar": null,
                    "LegalTitlePoint": null,
                    "LegalTitleSect": null,
                    "LegalTitleYear": null,
                    "MessageStatus": null,
                    "Owner_ID": null,
                    "PersonalDelivery": null,
                    "QTimestamp": null,
                    "Recipient": null,
                    "RecipientAddress": null,
                    "RecipientIdent": null,
                    "RecipientOrgUnit": null,
                    "RecipientOrgUnitNum": null,
                    "RecipientRefNumber": null,
                    "RestrictionDeliveryFiction": null,
                    "SenderAddress": null,
                    "SenderIdent": null,
                    "SenderOrgUnit": null,
                    "SenderOrgUnitNum": null,
                    "SenderRefNumber": null,
                    "SenderType": null,
                    "ToHands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "create",
            "id": "id1",
            "data": {
                "class_id": "databoxmessreceiveds",
                "object_data": {
                    "AmbiguousRecipient": null,
                    "AuthorName": null,
                    "AuthorUserType": null,
                    "DmType": null,
                    "IDRecipient": null,
                    "IDSender": null,
                    "LegalTitleLaw": null,
                    "LegalTitlePar": null,
                    "LegalTitlePoint": null,
                    "LegalTitleSect": null,
                    "LegalTitleYear": null,
                    "MessageStatus": null,
                    "Owner_ID": null,
                    "PersonalDelivery": null,
                    "QTimestamp": null,
                    "Recipient": null,
                    "RecipientAddress": null,
                    "RecipientIdent": null,
                    "RecipientOrgUnit": null,
                    "RecipientOrgUnitNum": null,
                    "RecipientRefNumber": null,
                    "RestrictionDeliveryFiction": null,
                    "SenderAddress": null,
                    "SenderIdent": null,
                    "SenderOrgUnit": null,
                    "SenderOrgUnitNum": null,
                    "SenderRefNumber": null,
                    "SenderType": null,
                    "ToHands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Update 
{
    "items": [
        {
            "type": "update",
            "id": "id0",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000100",
                "object_data": {
                    "AmbiguousRecipient": null,
                    "AuthorName": null,
                    "AuthorUserType": null,
                    "DmType": null,
                    "IDRecipient": null,
                    "IDSender": null,
                    "LegalTitleLaw": null,
                    "LegalTitlePar": null,
                    "LegalTitlePoint": null,
                    "LegalTitleSect": null,
                    "LegalTitleYear": null,
                    "MessageStatus": null,
                    "Owner_ID": null,
                    "PersonalDelivery": null,
                    "QTimestamp": null,
                    "Recipient": null,
                    "RecipientAddress": null,
                    "RecipientIdent": null,
                    "RecipientOrgUnit": null,
                    "RecipientOrgUnitNum": null,
                    "RecipientRefNumber": null,
                    "RestrictionDeliveryFiction": null,
                    "SenderAddress": null,
                    "SenderIdent": null,
                    "SenderOrgUnit": null,
                    "SenderOrgUnitNum": null,
                    "SenderRefNumber": null,
                    "SenderType": null,
                    "ToHands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        },
        {
            "type": "update",
            "id": "id1",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000101",
                "object_data": {
                    "AmbiguousRecipient": null,
                    "AuthorName": null,
                    "AuthorUserType": null,
                    "DmType": null,
                    "IDRecipient": null,
                    "IDSender": null,
                    "LegalTitleLaw": null,
                    "LegalTitlePar": null,
                    "LegalTitlePoint": null,
                    "LegalTitleSect": null,
                    "LegalTitleYear": null,
                    "MessageStatus": null,
                    "Owner_ID": null,
                    "PersonalDelivery": null,
                    "QTimestamp": null,
                    "Recipient": null,
                    "RecipientAddress": null,
                    "RecipientIdent": null,
                    "RecipientOrgUnit": null,
                    "RecipientOrgUnitNum": null,
                    "RecipientRefNumber": null,
                    "RestrictionDeliveryFiction": null,
                    "SenderAddress": null,
                    "SenderIdent": null,
                    "SenderOrgUnit": null,
                    "SenderOrgUnitNum": null,
                    "SenderRefNumber": null,
                    "SenderType": null,
                    "ToHands": null
                },
                "query": {
                    "select": [
                        "id"
                    ]
                }
            }
        }
    ]
}
Body - Delete 
{
    "items": [
        {
            "type": "delete",
            "id": "id0",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000100"
            }
        },
        {
            "type": "delete",
            "id": "id1",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000101"
            }
        },
        {
            "type": "delete",
            "id": "id2",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000102"
            }
        },
        {
            "type": "delete",
            "id": "id3",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000103"
            }
        },
        {
            "type": "delete",
            "id": "id4",
            "data": {
                "class_id": "databoxmessreceiveds",
                "obj_id": "1600000104"
            }
        }
    ]
}