Tenging skjala við önnur fyrirbæri

RB vill leggja fram breytingartillögu á IOBWS-þjónustunni Digital Documents (ÍST TS 314:2022, https://www.stadlar.is/stadlabudin/vara/?ProductName=IST-TS-314-2022 og https://github.com/stadlar/IST-FUT-FMTH/blob/master/Deliverables/IOBWS-Documents3.0.yaml) fyrir Staðlaráð (Icelandic Standards Council). Þessi breytingartillaga opnar notendum þjónustunnar möguleika til þess að tengja rafræn skjöl við fyrirbæri á borð við kröfur og greiðslur og leyfir þannig, til dæmis, kröfuhöfum að koma á, breyta, rjúfa og fá upplýsingar um tengingar milla krafna og skjala.

RB leggur til að eftirfarandi aðgerðum verði bætt við þjónustuna Digital Documents sem gera meðhöndlun tenginga milli skjals og einhvers (til dæmis krafna) mögulega:

1-n tengingar stofnaðar: POST /v1/crossreferences
1-n tengingar lesnar: GET /v1/crossreferences?documentStore={data-storage}&documentId={document-id}&keyType={key-type}&key={key}
1-n tengingar uppfærðar: PUT /v1/crossrefences
Tenging rofnin: DELETE /v1/crossreferences/{document-Store}/{document-id}/{key-type}/{key}?ExternalEventId={externalEventId}

Núverandi aðgerðir þjónustunnar Digital Documents (aðgerðirnar á /v1/documents) styðja allar bunkavirkni. Til þess að gæta samræmi milli aðgerða þjónustunnar er lagt til að POST og PUT /v1/crossreferences aðgerðirnar geri það einnig. Skil aðgerðanna yrðu þá í grófum dráttum eftirfarandi (ef aðgerðir skila ekki villu).

1-n tengingar stofnaðar POST /v1/crossreferences

Inntak HTTP-búkur:

[
    {
        "key": " 99391c7e-ad88-49ec-a2ad-99ddcb1f7721",
        "keyType": 1,
        "documentId": " 6e66fcae-f5a6-4584-a107-075ca237e3b7",
        "documentStore": 2,
        "documentCategory": 3,
        "documentDescription": "Description of document content",
        "dffectiveDate": "2024-04-01",
        "externalEventId": " b70e4d9a-b9e4-494f-a481-b470cc4c2ee4"
    },
    ...
]

Úttak

[
    {
        "key": " 99391c7e-ad88-49ec-a2ad-99ddcb1f7721",
        "keyType": 1,
        "documentId": " 6e66fcae-f5a6-4584-a107-075ca237e3b7",
        "documentStore": 2,
        "documentCategory": 3,
        "documentDescription": "Description of document content",
        "documentEdffectiveDate": "2024-04-01",
        "externalEventId": " b70e4d9a-b9e4-494f-a481-b470cc4c2ee4"
    },
    ...
]

og HTTP-stöðukóði 200.

1-n tengingar lesnar GET /v1/crossreferences?dataStorage={document-store}&documentId={document-id}&keyType={key-type}&key={key}

Inntak Fyrirspurnarviðföng (query parameters):

DocumentStore: Skjalageymsla.
DocumentId: Auðkenni skjals í skjalageymslunni.
KeyType: Tegund fyrirbæris sem er tengt við skjal (til dæmis krafa eða greiðsla).
Key: Auðkenni fyrirbæris sem er tengt við skjal.

(Þessi fjögur viðföng eru valkvæð með þeim fyrirvara að annað hvort þarf að tiltaka DocumentStore og DocumentId eða KeyType og Key.)

DocumentCategory: Skjalaflokkur (til dæmis greiðsluseðill, innheimtubréf eða launaseðill). Ef ótilgreint er tengingum með öllum skjalaflokkum skilað.
DateFrom: Upphafsdagsetning gildistökudags (effective date). Ef ótilgreint er upphafsdagsetning lágmarksdagsetning.
DateTo: Lokadagsetning gildistökudags (effective date). Ef ótilgreint er upphafsdagsetning hámarksdagsetning.
Page: Síðunúmer niðurstaðna. Ef ótilgreint er síðunúmer 1.
ItemsPerPage: Fjöldi tenginga á síðu. Ef ótilgreint er fjöldi tengina á síðu 10.

Úttak

[
    {
        "key": "cc15b0b1-eea5-4c65-adc9-b61a83fae528",
        "keyType": 1,
        "documentId": "00ec5225-8a64-48a2-b6bf-f4ef558b27df",
        "documentStore": 2,
        "documentCategory ": 3,
        "documentDescription": "hello world!",
        "documentEdffectiveDate": "2024-04-01",
        "externalEventId": "edd45ff6-265e-4cda-8d58-bdefea00acd2"
    },
    ...
]

og HTTP-stöðukóði 200.

1-n tenging uppfærð PUT /v1/crossrefences

Inntak

HTTP-búkur (HTTP-body): { [ "key": "cc15b0b1-eea5-4c65-adc9-b61a83fae528", "keyType": 1, "documentId": "00ec5225-8a64-48a2-b6bf-f4ef558b27df", "documentStore": 2, "documentCategory": 7, "documentDescription": "halló heimur!", "documentEdffectiveDate": "2024-04-01", "externalEventId": " 7646726c-8348-4561-af68-9a03f2337862" ], ... }

{ } og HTTP-stöðukóði 200.

Tenging rofnin DELETE /v1/crossreferences/{document-store}/{document-id}/{key-type}/{key}?ExternalEventId={externalEventId}

Inntak

Slóðarviðföng (path parameters):

document-store: Skjalageymsla.
document-id: Auðkenni skjals í skjalageymslunni.
key-type: Tegund fyrirbæris sem er tengt við skjal (til dæmis krafa eða greiðsla).
key: Auðkenni fyrirbæris sem er tengt við skjal.

Fyrirspurnarviðföng (query parameters):

ExternalEventId: Auðkenni atburðar í kerfi biðlara sem er ástæða kalls.

Úttak { } og HTTP-stöðukóði 204.

stadlar / IST-FUT-FMTH

Tenging skjala við önnur fyrirbæri #227