Tehnička specifikacija za web servis FINA e-Arhiv

U ovom tekstu opisuju se i definiraju svi web servisi u sustavu FINA e-Arhiv. Opisane su sve metode svih dostupnih web servisa kao i svi tehnički detalji.

Definicije i skraćenice

Vrste web servisa

Na sustavu FINA e-Arhiva za poslovne korisnike razvijene u 23 metode web servisa sa sinkronom obradom. Kako bi se zadovoljile sve potrebe za integraciju i korištenjem funkcionalnosti FINA e- Arhiva iz vanjskih sustava.

Sigurnosni preduvjeti

Zaštita prijenosnog kanala se radi korištenjem dvosmjernog kriptiranja kanala (2-way ssl) što znači da se pri uspostavljanju sigurne veze klijent predstavlja aplikacijskim certifikatom, a web server serverskim certifikatom.

Slijede preduvjeti potrebni za uspostavu web servisa sa sinkronom obradom. Korisnik treba sljedeće:

• posjedovati SSL certifikat povjerljivog izdavatelja
• zatražiti od FINA-e aplikacijski certifikat za potrebe:
  • potpisivanja SOAP poruka, i to demo za testiranje na prezentacijskoj okolini, produkcijski za produkcijsku okolinu nakon dovršenog testiranja
  • za klijentsku autentikaciju za uspostavljanje 2-way SSL-a
• prilagoditi sustav za zaprimanje i slanje SOAP poruka prema tehničkoj specifikaciji
• SOAP poruke moraju sadržavati Security header sa sigurnosnim tokenom, digitalnim potpisom (Signature) i vremenskom oznakom (Timestamp):
  • Schema za Security tag: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd
  • Za sigurnosni token se koristi BinarySecurityToken koji sadrži podatke o X.509 certifikatu    (http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0.pdf) enkodirane u Base64 formatu (http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf)
  • Schema za digitalni potpis (Signature): http://www.w3.org/2000/09/xmldsig#
  • Struktura potpisa propisana je Canonical XML algoritmom (http://www.w3.org/2001/10/xml-exc-c14n#) i koristi prefikse „soapenv v0 v01“.
  • Kod transformacije tijela poruke koristi se Canonical XML algoritam (http://www.w3.org/2001/10/xml-exc-c14n#) s prefiksima „v0 v01“.
  • Za digitalni potpis tijela poruke koriste se RSA i SHA-1 algoritmi (http://www.w3.org/2000/09/xmldsig#rsa-sha1)
  • Za generiranje sažetka tijela poruke koristi se SHA-1 algoritam (http://www.w3.org/2000/09/xmldsig#sha1)
  • Schema za Timestamp tag: http://docs.oasis-open.org/wss/2004/01/oasis- 200401-wss-wssecurity-utility-1.0.xsd

Signature element Security headera

Timestamp element Security headera

SOAP poruke web servisa

Zajednički dijelovi metoda web servisa

Sve poruke koje se šalju prema web servisu ili ih web servis šalje prema klijentu (poruka odgovora) imaju neke zajedničke elemente. Za poruke koje se šalju prema web servisu zajednički element je "ArchiveHeader", dok je za poruke odgovora zajednički element "MessageAck".

Zajednički element svih odlaznih poruka, ArchiveHeader:

Header element

• MessageId - jedinstveni broj poruke zahtjeva
• MessageType - tip poruke (moguće vrijednosti su navedene u poglavlju Tipovi poruka)
• MessageAttributes - atributi poruke (neobavezni)

ArhiveHeader – zajednički element

Zajednički element svih dolaznih poruka, ArchiveHeader:

MesageAck element:

• MessageAck
  • MessageID - jedinstveni broj poruke zahtjeva na koju se ova poruka odgovora odnosi
  • MessageAckID - jedinstveni broj poruke odgovora
  • MessageType - tip poruke (moguće vrijednosti su navedene u poglavlju Tipovi poruka)
  • AckStatus - status odgovora (moguće vrijednosti su navedene kod opisa svake metode)
    • ACCEPTED
    • MSG_NOT_VALID
    • SYSTEM_ERROR
  • AckStatusCode - šifra statusa
    • 0 - error response
    • 1 - success response
    • 400 - pogreška pri pozivu servisa
  • AckStatusText - opis statusa (neobavezno)

MessageAck – nalazi u odgovorima svih metoda web servisa

Detaljniji opis parametara koji se koriste u metodama web servisa

Metode web servisa

Ping

Metoda a testiranje veze prema web servisu, ako ova metoda vrati uspješan odgovor to znači da je veza uspješno uspostavljena.

Elementi ping poruke (ping metoda):

• Nema elemenata

Ping (request)

Elementi Pong poruke (response):

• Nema elemenata

Pong (response)

Kreiraj grupu dokumenata

Pošiljatelj kreira SOAP poruku za kreiranje nove grupe dokumenta te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi CreateGroupMsgType poruke (metoda createGroup):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • CertificateOwner OIB - OIB vlasnika certifikata
  • CertificateOwner AdditionalId - dodatni identifikator za vlasnika certifikata (neobavezan), npr. šifra poslovne jedince. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • GroupName - ime grupe
  • ObjectOwner OIB - OIB vlasnika za kojeg će se grupa kreirati
  • ObjectOwner AdditionalId - šifra vlasnika (vlasnik u čije se ime kreira grupa), dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.

Poruka CreateGroupMessageType

Elementi CreateGroupAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• CreateGroupEnvelope
  • GroupName - ime grupe
• Error 
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka CreateGroupAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/createGroup

Obriši grupu dokumenta

Pošiljatelj kreira SOAP poruku za brisanje grupe te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi DeleteGroupMsgType poruke (metoda deleteGroup):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • CertificateOwner OIB - OIB vlasnika certifikata
  • CertificateOwner AdditionalId - dodatni identifikator za vlasnika certifikata (neobavezan), npr. šifra poslovne jedince. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • GroupName - ime grupe
  • ObjectOwner OIB - OIB vlasnika čija će se grupa obrisati
  • ObjectOwner AdditionalId - šifra vlasnika (vlasnik čija grupa briše), dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.

Poruka DeleteGroupMsg

Elementi DeleteGroupAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• DeleteGroupEnvelope
• GroupName - ime grupe
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka DeleteGroupAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/deleteGroup

Dohvati sve dokumente iz grupe

Pošiljatelj kreira SOAP poruku za dohvat svih dokumenata iz grupe te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi GetAllDocumentsFromGroupMsgType (metoda getAllDocumentsFromGroup) poruke:

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • CertificateOwner OIB - OIB vlasnika certifikata
  • CertificateOwner AdditionalId - dodatni identifikator za vlasnika certifikata (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • GroupName - ime grupe,
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.

Poruka GetAllDocumentsFromGroupMsgType

Elementi GetAllDocumentsFromGroupAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• GetDocumentsEnvelope
  • DocumentCointainer - podatci o dokumentu
    • DocumentName - ime dokumenta
    • MimeType - tip dokumenta
    • DocumentGuid - identifikator dokumenta
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka GetAllDocumentsFromGroupAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/getAllDocumentsFromGroup

Dohvati sve grupe dokumenta

Pošiljatelj kreira SOAP poruku za dohvat svih grupa pridruženih dokumentu te poziva web servis na strani FINA-e. FINA zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi GetAllGroupsForDocumentMsgType (metoda getAllGroupsForDocument) poruke:

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • CertificateOwner OIB - OIB vlasnika certifikata
  • CertificateOwner AdditionalId - dodatni identifikator za vlasnika certifikata (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • DocumentGuid - GUID (identifikator) dokumenta
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.

Poruka GetAllGroupsForDocumentMsgType

Elementi GetAllGroupsForDocumentAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• GetGroupsEnvelope
  • GroupNameCointaner - ime grupe
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka GetAllGroupsForDocumentAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/getAllGroupsForDocument

Ukloni dokument iz grupe

Pošiljatelj kreira SOAP poruku za uklanjanje dokumenta iz grupe te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi poruke RemoveDocumentFromGroupMsgType (metoda removeDocumentFromGroup):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • CertificateOwner OIB - OIB vlasnika certifikata
  • CertificateOwner AdditionalId - dodatni identifikator za vlasnika certifikata (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • GroupName - ime grupe, detaljan opis je naveden u poglavlju 4.2
  • DocumentGuid - GUID (identifikator) dokumenta
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.

Poruka RemoveDocumentFromGroupMsgType

Elementi RemoveDocumentFromGroupAckMsgType poruka (metoda removeDocumentFromGroup):

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• RemoveDocumentEnvelope
  • GroupName - ime grupe
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka RemoveDocumentFromGroupAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/removeDocumentFromGroup

Dodaj dokument u grupu

Pošiljatelj kreira SOAP poruku za pridruživanje grupe dokumentu te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi AssignDocumentToGroupMsgType poruke (metoda assignDocumentToGroup):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • CertificateOwner OIB - OIB vlasnika certifikata
  • CertificateOwner AdditionalId - dodatni identifikator za vlasnika certifikata (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.GroupName - ime grupe
  • DocumentGuid - GUID (identifikator) dokumenta
  • GroupName - ime grupe, detaljan opis je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.

Poruka AssignDocumentToGroupMsgType

Elementi AssignDocumentToGroupMsgType poruka (metoda assignDocumentToGroup):

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• AssignDocumentEnvelope
  • GroupName - ime grupe
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka AssignDocumentToGroupAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/assignDocumentToGroup

Kreiraj spremnik

Pošiljatelj kreira SOAP poruku za kreiranje novog spremnika te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi CreateContainerMsgType poruke (metoda createContainer):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • ContainerName - naziv spremnika

Poruka CreateContainerMsgType

Elementi CreateContainerAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• CreateContainerEnvelope
• ContainerGuid - identifikator spremnika - GUID
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka CreateContainerAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/createContainer

Preimenuj spremnik

Pošiljatelj kreira SOAP poruku za preimenovanje spremnika te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi RenameContainerMsgType poruke (metoda renameContainer):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • ContainerOldName - trenutni naziv spremnika
  • ContainerNewName - željeni naziv spremnika

Poruka RenameContainerMsgType

Elementi RenameContainerAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• RenameContainerEnvelope
  • ContainerOldName - stari naziv spremnika
  • ContainerNewName - novi naziv spremnika
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka RenameContainerAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/renameContainer

Obriši spremnik

Pošiljatelj kreira SOAP poruku za brisanje spremnika te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi DeleteContainerMsgType poruke (metoda deleteContainer):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • ContainerName - naziv spremnika

Poruka DeleteContainerMsgType

Elementi DeleteContainerAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• DeleteContainerEnvelope
• ContainerName - naziv spremnika
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka DeleteContainerAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/deleteContainer

Kreiraj direktorij

Pošiljatelj kreira SOAP poruku za kreiranje novog direktorija te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi CreateFolderMsgType poruke (metoda createFolder):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • ObjectOwner OIB - OIB vlasnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • ContainerName - naziv spremnika
  • FolderName - naziv direktorija
  • FolderPath - putanja do direktorija
  • Alias - alias direktorija (neobavezno)
  • IsLocked - aktiviraj/deaktiviraj direktorij (neobavezno)

Poruka CreateFolderMsgType

Elementi CreateFolderAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• CreateFolderEnvelope
• FolderGuid - identifikator direktorija
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka CreateFolderAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/createFolder

Preimenuj direktorij

Pošiljatelj kreira SOAP poruku za preimenovanje direktorija te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi RenameFolderMsgType poruke (metoda renameFolder):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • ObjectOwner OIB - OIB korisnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • ContainerName - naziv spremnika
  • FolderNewName - željeni naziv direktorija, smije se sastojati samo od alfanumeričkih znakova engleske abecede i razmaka. Duljina naziva mora biti između u 1 i 50 znakova.
  • FolderOldPath - putanja do direktorija zajedno s nazivom direktorija ("nazivSpremnika/ostali/direktorij")
Alias - alias direktorija (neobavezno)

Poruka RenameFolderMsgType

Elementi RenameFolderAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• DocumentEnvelope
• FolderNewName - novi naziv direktorija
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka RenameFolderAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/renameFolder

Obriši direktorij

Pošiljatelj kreira SOAP poruku za brisanje direktorija te poziva web servis na strani Fine. Fina zatim sinkrono obradi i odgovori na poruku.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi DeleteFolderMsgType poruke (metoda deleteFolder):

• Header
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data
  • ObjectOwner OIB - OIB korisnika
  • ObjectOwner AdditionalId - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice. U slučaju da se ovaj parametar ne navede pretpostavit će se vrijednost 1111111111111.
  • ContainerName - naziv spremnika
  • FolderPath - putanja do direktorija zajedno s nazivom direktorija ("nazivSpremnika/ostali/direktorij")

Poruka DeleteFolderMsgType

Elementi DeleteFolderAckMsgType poruka:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• DeleteFolderEnvelope
  • ContainerName - naziv spremnika
  • FolderOldPath - putanja gdje se nalazio obrisani direktorij
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka DeleteFolderAckMsgType

SOAPAction:

http://fina.hr/archive/ws/sync/deleteFolder

Arhiviranje dokumenta

Pošiljatelj kreira SOAP poruku za arhiviranje dokumenta te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi ArchiveDocumentMsg poruke (metoda archiveDocument):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / ArchiveDocumentEnvelope / DocumentEnvelope
  • ArchiveContainer - Podaci o spremniku
    • ObjectOwner - Podaci o vlasniku spremnika
      • OIB - OIB vlasnika spremnika
      • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
    • ContainerName - Naziv spremnika
    • FolderPath - Putanja do direktorija (u formatu "nazivSpremnika/ostali/direktoriji")
  • ArchiveClassID - Klasa za dokument (GUID)
  • ClassMetadata - Metapodaci (nijednom ili više puta)
    • PropertyName - Naziv metapodatka
    • PropertyValue - Vrijednost metapodatka, ovisi o vrsti metapodatka:
      • za STRING – maksimalan broj znakova
      • za INTEGER – cijeli broj između -231 i 231-1
      • za DATETIME – postojeći datum u formatu "gggg-mm-dd" ili "dd.mm.gggg"
      • za FLOAT – decimalni broj s decimalnim zarezom
      • za BOOLEAN – pozitivna ("1", "TRUE", "true" "DA", "da") ili negativna ("0", "FALSE", "false" "NE", "ne") logička izjava
  • ArchiveTag - Podaci o grupi dokumenata (neobavezno)
    • TagOwnerOIB - OIB vlasnika grupe dokumenata, tj. taga
    • TagOwnerAdditionalID - šifra vlasnika taga, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
    • Tag - Naziv grupe dokumenata (jednom ili više puta)
  • AttachedDocumentEnvelope - Podaci o datoteci dokumenta
    • FileName - Naziv datoteke
    • MimeType - MIME tip datoteke
    • AttachedDocument - Datoteka u Base64 formatu

Poruka ArchiveDocumentMsg

DocumentEnvelope, element poruka ArchiveDocumentMsg i ArchiveDocumentChunkMsg

Elementi ArchiveDocumentAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• ArchiveDocumentEnvelope
  • DocumentGUID - GUID (identifikator) arhiviranog dokumenta
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Poruka ArchiveDocumentAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/archiveDocument

Arhiviranje dokumenta u dijelovima

Pošiljatelj kreira SOAP poruku za arhiviranje dokumenta u dijelovima (chunkovima) te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi ArchiveDocumentChunkMsg poruke (metoda archiveDocumentChunk):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / ArchiveDocumentChunkEnvelope / DocumentEnvelope
  • ArchiveContainer - Podaci o spremniku
    • ObjectOwner - Podaci o vlasniku spremnika
      • OIB - OIB vlasnika spremnika
      • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
    • ContainerName - Naziv spremnika
    • FolderPath - Putanja do direktorija (u formatu "nazivSpremnika/ostali/direktoriji")
    • ArchiveClassID - Klasa za dokument (GUID)
    • ClassMetadata - Metapodaci (nijednom ili više puta)
      • PropertyName - Naziv metapodatka
      • PropertyValue - Vrijednost metapodatka, ovisi o vrsti metapodatka:
        • za STRING – maksimalan broj znakova
        • za INTEGER – cijeli broj između -231 i 231-1
        • za DATETIME – postojeći datum u formatu "gggg-mm-dd" ili "dd.mm.gggg"
        • za FLOAT – decimalni broj s decimalnim zarezom
        • za BOOLEAN – pozitivna ("1", "TRUE", "true" "DA", "da") ili negativna ("0", "FALSE", "false" "NE", "ne") logička izjava
    • ArchiveTag - Podaci o grupi dokumenata (neobavezno)
      • TagOwnerOIB - OIB vlasnika grupe dokumenata, tj. taga
      • TagOwnerAdditionalID - Dodatni identifikator vlasnika grupe dokumenata, tj. taga - poslovna jedinica (neobavezno)
      • Tag - Naziv grupe dokumenata (jednom ili više puta)
    • AttachedDocumentEnvelope - Podaci o datoteci dokumenta
      • FileName - Naziv datoteke
      • MimeType - MIME tip datoteke
      • AttachedDocument - Datoteka u Base64 formatu
  • UploadMetadata - Podaci o slanju chunka
    • MD5 - Hash funkcija koja računa sažetak datoteke
    • Part - Broj chunka
    • PartsCount - Ukupan broj chunkova
    • UploadID - Identifikator lokacije pohrane chunkova datoteke (prazna vrijednost u poruci s prvim chunkom, u porukama s preostalim chunkovima šalje se vrijednost primljena u odgovoru na poruku s prvim chunkom - DocumentEnvelope/UploadId) u formatu "nazivDatoteke-NNNNNNN" gdje je "NNNNNNN" 7 nasumično generiranih brojeva.

Poruka ArchiveDocumentChunkMsg

Dio poruke UploadMetadata

Elementi ArchiveDocumentChunkAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• ArchiveDocumentChunkEnvelope
  • UploadId - Identifikator lokacije pohrane chunkova datoteke (definira se kod odgovora na poruku s prvim chunkom)
  • ChunkStatus - Status chunka:
    • Chunk je validan
    • Chunk nije validan
  • DocumentGUID - GUID arhiviranog dokumenta (neobavezno)
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka ArchiveDocumentChunkAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/archiveDocumentChunk

Arhiviranje dokumenta u više direktorija

Pošiljatelj kreira SOAP poruku za arhiviranje dokumenta u više direktorija te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi ArchiveDocumentInMultipleFoldersMsg poruke (metoda archiveDocumentInMultipleFolders):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / ArchiveDocumentInMultipleFoldersEnvelope / DocumentInMultipleFoldersEnvelope
  • ArchiveContainer - Podaci o spremniku
    • ObjectOwner - Podaci o vlasniku spremnika
      • OIB - OIB vlasnika spremnika
      • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
    • ContainerName - Naziv spremnika
  • ArchiveClassID - Klasa za dokument (GUID)
  • ClassMetadata - Metapodaci (nijednom ili više puta)
    • PropertyName - Naziv metapodatka
    • PropertyValue - Vrijednost metapodatka, ovisi o vrsti metapodatka:
      • za STRING – maksimalan broj znakova
      • za INTEGER – cijeli broj između -231 i 231-1
      • za DATETIME – postojeći datum u formatu "gggg-mm-dd" ili "dd.mm.gggg"
      • za FLOAT – decimalni broj s decimalnim zarezom
      • za BOOLEAN – pozitivna ("1", "TRUE", "true" "DA", "da") ili negativna ("0", "FALSE", "false" "NE", "ne") logička izjava
  • ArchiveFolder – Podaci o direktorijima (jednom ili više puta)
    • FolderPath - Putanja do direktorija (u formatu "nazivSpremnika/ostali/direktoriji")
    • ArchiveTag - Podaci o grupi dokumenata (neobavezno):
    • TagOwnerOIB - OIB vlasnika grupe dokumenata, tj. Taga
    • TagOwnerAdditionalID - šifra vlasnika taga, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
    • Tag - Naziv grupe dokumenata (jednom ili više puta)
  • AttachedDocumentEnvelope - Podaci o datoteci dokumenta
    • FileName - Naziv datoteke
    • MimeType - MIME tip datoteke
    • DocumentInMultipleFoldersEnvelope, element poruke ArchiveDocumentInMultipleFoldersMsgAttachedDocument - Datoteka u Base64 formatu

Poruka ArchiveDocumentInMultipleFoldersMsg

DocumentInMultipleFoldersEnvelope, element poruke ArchiveDocumentInMultipleFoldersMsg

Elementi ArchiveDocumentInMultipleFoldersAckMsg poruke jednaki su elementima ArchiveDocumentAckMsg poruke opisane u poglavlju Arhiviranje dokumenta.

Poruka ArchiveDocumentInMultipleFoldersAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/archiveDocumentInMultipleFolders

Kreiranje klase dokumenata

Pošiljatelj kreira SOAP poruku za kreiranje klase dokumenata te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi CreateClassMsg poruke (metoda createClass):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / CreateClassEnvelope
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ClassName - Naziv klase
  • ContainerName - Naziv spremnika
  • ClassMetadata - Metapodaci (jednom ili više puta)
    • PropertyName - Naziv metapodatka
    • IsMandatory - Oznaka obaveznosti metapodatka
      • 0 - metapodatak nije obavezan
      • 1 - metapodatak je obavezan
  • PropertyType - Vrsta metapodatka:
    • STRING - Tekst
    • INT - Broj
    • FLOAT - Decimalni broj
    • DATE - Datum
    • BOOLEAN - Logička izjava

Poruka CreateClassMsg

Elementi CreateClassAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• CreateClassEnvelope
  • ClassGUID - GUID klase (koristi se kao ArchiveClassID kod arhiviranja dokumenta)
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka CreateClassAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/createClass

Preimenovanje klase dokumenata

Pošiljatelj kreira SOAP poruku za preimenovanje klase dokumenata te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi RenameClassMsg poruke (metoda renameClass):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / RenameClassEnvelope
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ContainerName - Naziv spremnika
  • ClassGUID - GUID klase
  • ClassNewName - Novi naziv klase

Poruka RenameClassMsg

Elementi RenameClassAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• RenameClassEnvelope
  • ClassOldName - Stari naziv klase
  • ClassNewName - Novi naziv klase
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka RenameClassAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/renameClass

Brisanje klase dokumenata

Pošiljatelj kreira SOAP poruku za brisanje klase dokumenata te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi DeleteClassMsg poruke (metoda deleteClass):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / DeleteClassEnvelope
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ContainerName - Naziv spremnika
  • ClassGUID - GUID klase

Poruka DeleteClassMsg

Elementi DeleteClassAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• DeleteClassEnvelope (neobavezno)
  • ClassName - Naziv obrisane klase
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka DeleteClassAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/deleteClass

Kreiranje vlasnika

Pošiljatelj kreira SOAP poruku za kreiranje vlasnika te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.

Elementi CreateOwnerMsg poruke (metoda createOwner):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / CreateOwnerEnvelope
  • CertificateOwner - Podaci o vlasniku certifikata
    • OIB - OIB vlasnika certifikata
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ObjectOwner - Podaci o vlasniku
    • OIB - OIB vlasnika
    • AdditionalID - - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • OwnerName - Naziv vlasnika
  • OwnerType - Vrsta vlasnika:
    • 1 - Poslovni subjekt
    • 2 - Fizička osoba

Poruka CreateOwnerMsg

Elementi CreateOwnerAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• CreateOwnerEnvelope
• OwnerName - Naziv kreiranog vlasnika
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka CreateOwnerAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/createOwner

Pretraga dokumenata

Pošiljatelj kreira SOAP poruku za pretragu dokumenata te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi SearchDocumentMsg poruke (metoda searchDocument):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / SearchDocumentEnvelope
  • CertificateOwner - Podaci o vlasniku certifikata
    • OIB - OIB vlasnika certifikata
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ContainerName - Naziv spremnika
  • ClassGUID - GUID klase
  • SearchMetadata - Podaci o metapodacima za pretragu (nijednom ili više puta)
    • PropertyName - Naziv metapodatka
    • PropertyValue - Vrijednost metapodatka
    • PropertyType - Vrsta metapodatka:
      • STRING - Tekst
      • INT - Broj
      • FLOAT - Decimalni broj
      • DATE - Datum
      • BOOLEAN - Logička izjava
    • PropertyOperator - Operator za vrijednost metapodatka:
      • EQUALS - Jednako
      • CONTAINS - Sadrži
      • LESS_OR_EQUALS_THAN - Manje ili jednako
      • GRETAER_OR_EQUALS_THAN - Veće ili jednako
  • DocumentName - Naziv dokumenta (neobavezno)
  • DocumentDate - Datum dokumenta (u formatu "gggg-mm-dd") (neobavezno)
  • FolderPath - Putanja direktorija (u formatu "nazivSpremnika/ostali/direktoriji") (neobavezno)
  • PageSize - Broj zapisa po stranici rezultata

Poruka SearchDocumentMsg

Elementi SearchDocumentAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• SearchDocumentEnvelope
  • DocumentGUID - GUID pronađenog dokumenta (jednom ili više puta)
  • DocumentsNumber - Ukupan broj pronađenih dokumenata
  • PageNumber - Redni broj stranice rezultata
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka SearchDocumentAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/searchDocument

Brisanje dokumenata

Pošiljatelj kreira SOAP poruku za brisanje dokumenata te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi DeleteDocumentMsg poruke (metoda deleteDocument):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / DeleteDocumentEnvelope
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • DocumentGUID - GUID dokumenta za brisanje (jednom ili više puta)

Poruka DeleteDocumentMsg

Elementi DeleteDocumentAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• DeleteDocumentEnvelope
  • RemovedDocumentsContainer - GUID uspješno obrisanog dokumenta (jednom ili više puta)
  • NotRemovedDocumentsContainer - GUID dokumenta koji nije uspješno obrisan (jednom ili više puta)
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka DeleteDocumentAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/deleteDocument

Preuzimanje dokumenta

Pošiljatelj kreira SOAP poruku za preuzimanje dokumenta te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi DownloadDocumentMsg poruke (metoda downloadDocument):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / DownloadDocumentEnvelope
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • DocumentGUID - GUID dokumenta za preuzimanje

Poruka DownloadDocumentMsg

Elementi DownloadDocumentAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• AttachedDocumentEnvelope
  • FileName - Naziv datoteke
  • MimeType - MIME tip datoteke
  • AttachedDocument - Datoteka dokumenta u Base64 formatu
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka DownloadDocumentAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/downloadDocument

Dodjela prava korisniku

Pošiljatelj kreira SOAP poruku za dodjelu (ili oduzimanje) prava korisniku te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi GrantPermissionForUserMsg poruke (metoda grantPermissionForUser):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / GrantPermissionEnvelope
  • CertificateOwner - Podaci o vlasniku certifikata
    • OIB - OIB vlasnika certifikata
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • UserOIB - OIB korisnika kojemu se uređuju prava
  • Functionalities - Funkcionalnosti (jednom ili više puta):
    • AKTIVIRAJ_KORISNIKA - Aktivacija korisnika
    • DEAKTIVIRAJ_KORISNIKA - Deaktivacija korisnika
    • DOZVOLI_ARHIVIRANJE_DOKUMENTA_ISTOG_NAZIVA - Dozvola arhiviranja dokumenta istog naziva
    • KREIRAJ_SPREMNIK - Kreiranje spremnika
    • DODAJ_RAZDRUZI_DOKUMENT_IZ_GRUPE - Dodavanje i razduživanje dokumenta iz grupe
  • Action - Akcija nad funkcionalnostima:
    • DODAJ - Navedene funkcionalnosti se dodjeljuju korisniku
    • ODUZMI - Navedene funkcionalnosti se oduzimaju korisniku
    • PROTOTIP - Navedene funkcionalnosti se dodjeljuju prototip korisniku

Poruka GrantPermissionForUserMsg

Elementi GrantPermissionForUserAckMsg poruke:

• MessageAck
Struktura MessageAck elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• GrantPermissionEnvelope
  • PermissionDetails – Tekstualni popis funkcionalnosti za koje su uređena prava korisniku
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovora poruka GrantPermissionForUserAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/grantPermissionForUser

Dodjela prava korisniku na direktorij

Pošiljatelj kreira SOAP poruku za dodjelu (uređivanje) prava korisniku na direktorij te poziva web servis na strani Fine. Fina sinkrono radi obradu primljene poruke i vraća odgovor.
(detaljni opis određenih parametra je naveden u poglavlju Detaljniji opis parametara koji se koriste u metodama web servisa)

Elementi GrantPermissionOnFolderForUserMsg poruke (metoda grantPermissionOnFolderForUser):

• ArchiveHeader
Struktura Header elementa je zajednički dio zahtjeva kod svih metoda i opisana je u poglavlju Zajednički dijelovi metoda web servisa
• Data / GrantPermissionFolderEnvelope
  • CertificateOwner - Podaci o vlasniku certifikata
    • OIB - OIB vlasnika certifikata
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • ObjectOwner - Podaci o vlasniku spremnika
    • OIB - OIB vlasnika spremnika
    • AdditionalID - šifra vlasnika, dodatni identifikator (neobavezan), npr. šifra poslovne jedinice
  • UserOIB - OIB korisnika kojemu se uređuju prava
  • Functionalities - Funkcionalnosti (jednom ili više puta):
    • ARHIVIRANJE_DOKUMENTA - Arhiviranje dokumenata
    • PREUZIMANJE_DOKUMENTA - Preuzimanje dokumenata
    • BRISI_DOKUMENT - Brisanje dokumenata
    • KREIRAJ_DIREKTORIJ - Kreiranje direktorija
    • OBRISI_DIREKTORIJ - Brisanje direktorija
    • PREIMENUJ_DIREKTORIJ - Preimenovanje direktorija
    • PRETRAZI - Pretraga dokumenata
    • PREMJESTI_DOKUMENT - Premještanje dokumenata
    • OBRISI_SPREMNIK - Brisanje spremnika
    • PREIMENUJ_SPREMNIK - Preimenovanje spremnika
    • KREIRAJ_KLASU - Kreiranje klasa
    • OBRISI_KLASU - Brisanje klasa
    • PREIMENUJ_KLASU - Preimenovanje klasa
    • PRIDRUZI_KLASU - Pridruživanje klasa
    • PRIKAZI_ZAKLJUCANI_SPREMNIK - Prikaz zaključanih spremnika
  • FolderPath - Putanja direktorija (u formatu “nazivSpremnika/ostali/direktoriji”)
  • Action - Akcija nad funkcionalnostima:
    • DODAJ - Navedene funkcionalnosti se dodjeljuju korisniku
    • ODUZMI - Navedene funkcionalnosti se oduzimaju korisniku
    • PROTOTIP - Navedene funkcionalnosti se dodjeljuju prototip korisniku

Poruka GrantPermissionOnFolderForUserMsg

Elementi GrantPermissionOnFolderForUserAckMsg poruke:

• MessageAck
  • MessageID - Jedinstveni broj poruke
  • MessageAckID - Jedinstveni broj poruke na koju se odnosi odgovor
  • MessageType - Tip poruke (moguće vrijednosti su navedene u poglavlju 7.)
  • AckStatus - Status odgovora:
    • ACCEPTED
    • MSG_NOT_VALID
    • SYSTEM_ERROR
  • AckStatusCode - Šifra statusa:
    • 0 - error response
    • 1 - success response
    • 400 - pogreška pri pozivu servisa
  • AckStatusText - Opis statusa (neobavezno)
• GrantPermissionFolderEnvelope
  • PermissionDetails – Tekstualni popis funkcionalnosti za koje su uređena prava korisniku
• Error
Struktura Error elementa je zajednički dio odgovora kod svih metoda i opisana je u poglavlju Šifrarnik mogućih grešaka kod slanja poruka

Sinkrona odgovorna poruka GrantPermissionOnFolderForUserAckMsg

SOAPAction:

http://fina.hr/archive/ws/sync/grantPermissionOnFolderForUser

Šifrarnik mogućih grešaka kod slanja poruka

ErrorType - šalje se u kao dio odgovorne poruke u slučaju greške

ErrorType element:

• ErrorCode - šifra greške
• ErrorMessage - Sadržaj greške
• ErrorText - Sadržaj greške

Adrese web servisa na strani Fine

Tipovi poruka