Zmiany pomiędzy wersją 18 and wersją 19 dla DeployerGuide/Others/eDokumentyApi

Data i czas:

11/09/11 13:18:18 (14 years temu)

Autor:

TS (IP: 213.227.67.33)

Komentarz:

--

DeployerGuide/Others/eDokumentyApi

@@ -41 +41 @@
 #!php
 <?php
-// Dokumentacja Webservice - API systemu eDokumenty w wersji 0.9.9
+// Dokumentacja Webservice - API systemu eDokumenty w wersji 1.1.0
+Dokumentacja Webservice - API systemu eDokumenty w wersji 1.1.0
+
+Usługa jest dostępna pod adresem:
+
+http://{host}:{port}/apps/edokumenty/classes/eDokumentyApi/EDokApiServer.php
+
+Opcjonalnie od wersji 0.9.8 usługa jest dostępna pod skróconym adresem: 
+
+http://{host}:{port}/eDokumentyApi.php
+
+Usługa jest zabezpieczona rozszerzeniem WSSecurity protokołu SOAP i wymaga
+podania w nagłówkach wywołania XML nazwy użytkownika i hasła.
+
+
 /**
  *  Tworzy nowy dokument 
@@ -60 +74 @@
 Int createDocument(Array data)
 
+/**
+ *  Dodaje pracownika do uprawnionych w dokumencie
+ *   
+ *  @param doc_id Int - id dokumentu (documents:doc_id)
+ *  @param usr_id Int - id pracownika (users:usr_id)
+ *  @param rights String - poziom uprawnień (r - odczyt, w - zapis, m - zarządzanie)
+ *  @param prionl Bool - udostępnij tylko uprawnionym użytkownikom
+ *   
+ *  @return Int - 1 jeśli sukces , 0 w razie niepowodzenia
+ *   
+ *  @throws Exception - SoapFault
+ */
+Int grantUserAccessToDocument(Int doc_id, Int usr_id, String rights, Bool prionl)
+
+/**
+ *  Dodaje grupę do uprawnionych w dokumencie
+ *   
+ *  @param doc_id Int - id dokumentu (documents:doc_id)
+ *  @param grp_id Int - id grupy (groups:grp_id)
+ *  @param rights String - poziom uprawnień (r - odczyt, w - zapis, m - zarządzanie)
+ *  @param prionl Bool - udostępnij tylko uprawnionym użytkownikom
+ *   
+ *  @return Int - 1 jeśli sukces , 0 w razie niepowodzenia
+ *   
+ *  @throws Exception - SoapFault
+ */
+Int grantGroupAccessToDocument(Int doc_id, Int grp_id, String rights, Bool prionl)
 
  /**
@@ -74 +115 @@
  */
 Int addAttachmentToDocument(String fileContent, String fileName, Int documentId)
+
+
+/**
+ * Ustawia meta text załącznika (używany przy wyszukiwaniu)
+ *
+ * @param int $fileid ID załącznika
+ * @param string $text
+ *
+ * @return bool true on success, false otherwise
+ *
+ * @since 1.0.1
+ * @throws Exception - SoapFault
+ */
+bool function setFileMetaText($fileid, $text)
 
 
@@ -103 +158 @@
  *  @param data Array - Tablica z parametrami
  *  @param data['dscrpt'] String - opis sprawy
- *  @param data['briefcase_symbol'] String - symbol teczki (można podać zamiast dsexid np. DO.1040)
+ *  @param data['briefcase_symbol'] String - symbol teczki
  *  @param data['dsexid'] int - identyfikator teczki (doss_exctract_list:dsexid)
  *  @param data['orunid'] int - identyfikator jednostki organizacyjnej, pod którą zostanie utworzona sprawa (organization_units:orunid)
  *  @param data['rspoid'] int - identyfikator osoby odpowiedzialnej w sprawie (organization_units:orunid)
  *  @param data['prtpid'] int - identyfikator procedury (procedures_def:prtpid)
+ *  @param data['comnts'] String - uwagi
  *  @param data['contact_symbol'] String - symbol kontaktu (contacts:symbol)
  *   
@@ -267 +323 @@
 Int completeStage(Int procid, Int ptstid, Int next_ptstid = NULL)
 
+
+/**
+ *  Zwraca dane dotyczące typu dokumentu na podstawie jednego z poniższych parametrów
+ *   
+ *  @param data Array - Tablica z parametrami
+ *  @param dctpid Int - ID typu dokumentu
+ *  @param dctptp String - 
+ *   
+ *  @return Array
+ *   
+ *  @throws Exception - SoapFault
+ */
+Array getDocumentTypeData(Array data)
+
+
+/**
+ *  Zwraca dane dotyczące jednostki organizacyjnej na podstawie jednego z poniższych parametrów
+ *   
+ *  @param data Array - Tablica z parametrami
+ *  @param orunid Int - ID jednostki organizacyjnej
+ *  @param usr_id Int - ID jednostki organizacyjnej
+ *  @param usrnam String - Nazwa użytkownika
+ *  @param fullnm String - Imię i Nazwisko użytkownika
+ *   
+ *  @return Array
+ *   
+ *  @throws Exception - SoapFault
+ */
+Array getOrganizationUnit(Array data)
+
+
+/**
+ *  Ustawienie cechy
+ *   
+ *  @param featid Int - Identyfikator cechy (features.featid)
+ *  @param tblnam String - Identyfikator tekstowy obiektu do jakiego jest przypisana cecha 
+ *                          (contacts - Kontakty, types_of_documents_view - Dokumenty, processes - Sprawy, events - Zdarzenia, 
+ *                          users - Pracownicy, devices - Urządzenia, depository - Produkty, resources - Zasoby)
+ *  @param tbl_id Int - Identyfikator obiektu, klucz główny wskazany w tblnam, gdzie tblnam to nazwa tabeli czyli dla contacts tbl_id = contid
+ *                          wyjątkiem są dokumenty tam tbl_id wskazuje na doc_id z tabeli documents
+ *  @param value Mixed - Wartość cechy. W przypadku cech wyboru definiowanych przez użytkownika (oznaczonych atrybutem multi_ w tabeli features_view) parametr ten musi być tablicą.
+ *                          Dodatkowo aby usunąć wartość z cechy value === NULL (nie pusty string a NULL)
+ *   
+ *  @return int - 1 sukces, 0 w razie niepowodzenia
+ *   
+ *  @throws Exception - SoapFault
+ */
+Int setFeatureValue(Int featid, String tblnam, Int tbl_id, Mixed value)
+
+
 ?>
 }}}