注意事項
※ 群組分享功能目前僅支援設定目錄(Folder) 為協同合作資料夾。
※ 白名單及設定協同合作資料夾的詳細說明請參照本文件「InfoRelay 分享功能簡介」。
※ 每次呼叫該 API 都會增加一個新的雲端分享碼，而舊的雲端分享碼仍保持有效。但是檔案／目錄的分享狀態(<password>、<validityduration>、<shareforuserid>、<folderquota>參數的效果)無論新舊分享碼皆採用最新一個雲端分享碼的設定

※ 範例：
有一分享目錄A，舊分享碼設定密碼為「abc123」；新分享碼設定密碼為「def456」。舊分享碼依舊可以存取到目錄 A，但存取所需的密碼已變更為「def456」。

※ 長分享碼：

• OmniStor 系統的雲端分享碼有「長分享碼」與「短分享碼」兩種類型，此 API 取得的雲端分享碼為「長分享碼」類型。

• 「長分享碼」須呼叫 ServicePortal 的 /sharecode/tocompactform/ 轉換成「短分享碼」方能進行 ibon 列印。

<!--?xml version="1.0" encoding="utf-8" ?-->
<setadvancedsharecode>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <isfolder>[ 0 | 1 ]</isfolder>    <!-- 0：表示為 File ID | 1：表示為 Folder ID。若為 File ID，將不支援白名單功能。 -->
    <entryid>{ File ID | Folder ID }</entryid>
    <clearshare>[ 0 | 1 ]</clearshare>    <!-- 選擇性欄位，預設值為 0。若設為 1 表示刪除此檔案／目錄以及子目錄下所有的雲端分享碼，不再分享此 Entry。設定此參數時，系統會忽視 isfolder、entryid 之外的參數特性(Ex: <password>、 <isgroupaware>參數) -->
    <clearpassword>[ 0 | 1 ]</clearpassword>    <!-- 選擇性欄位，預設值為 0。若設為 1 表示移除存取此 Entry 時所需的密碼，可直接存取。設定此參數時，系統會忽視<password>參數 -->
    <clearvalidityduration>[ 0 | 1 ]</clearvalidityduration>    <!-- 選擇性欄位，預設值為 0。若設為 1 表示移除此分享碼的時間限制。設定此參數時，系統會忽視<validityduration>參數 -->
    <releasequotalimit>[ 0 | 1 ]</releasequotalimit>    <!-- 選擇性欄位，預設值為 0。若設為 1 表示移除此分享碼的使用空間限制。設定此參數時，系統會忽視<folderquota>參數 -->
    <password>{ 透過分享碼存取該檔案／目錄所須的密碼 }</password>    <!-- 選擇性欄位。預設為無此欄位，表示不須密碼 -->
    <validityduration>{ 雲端分享碼多久後失效 }</validityduration>    <!-- 選擇性欄位。單位：小時-->
    <isgroupaware>[ 0 | 1 ]</isgroupaware>    <!-- 選擇性欄位。0：不啟用協同合作資料夾功能 | 1：啟用協同合作資料夾功能 -->    <!-- shareforuserid element可以重覆多次，為選擇性欄位 -->
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#1 }</shareforuserid>
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#2 }</shareforuserid>
    <shareforuserid>{ …… }</shareforuserid>
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#N }</shareforuserid>
    <folderquota>{ 設定協同合作資料夾被分享者可上傳檔案的空間上限 }</folderquota>    <!-- 選擇性欄位。單位：byte -->
</setadvancedsharecode>

<!--?xml version="1.0" encoding="utf-8" ?-->
<setadvancedsharecode>
    <status>{ Status Code }</status>
    <scrip>{ Scrip }</scrip>
    <sharecode>{ 雲端分享碼 }</sharecode>
    <ispasswordneeded>[ 0 | 1 ]</ispasswordneeded>    <!-- 0：不須密碼即可存取 | 1：須輸入密碼 -->
    <isgroupaware>[ 0 | 1 ] </isgroupaware>    <!-- 若為 1 表示支援群組編輯，反之，則不支援 -->
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#1 }</shareforuserid>
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#2 }</shareforuserid>
    <shareforuserid>{ …… }</shareforuserid>
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#N }</shareforuserid>
    <expiredtime>{ yyyy-MM-dd HH:mm:ss。若此欄為空表示未指定逾期時間 }</expiredtime>    <!-- 單位：小時-->
    <folderquota>{ 協同合作資料夾被分享者可上傳檔案的空間上限 }</folderquota>    <!-- 單位：byte -->
    <invaliduserid>{ 不是 OmniStor 帳號的白名單用戶 }</invaliduserid>    <!-- 可為多筆的。不屬於 OmniStor 帳號的用戶無法使用群組分享功能 -->
</setadvancedsharecode>

此 API 取得的雲端分享碼為「長分享碼」類型。

<!--?xml version="1.0" encoding="utf-8" ?-->
<getadvancedsharecode>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <isfolder>[ 0 | 1 ] </isfolder>    <!-- 0：表示為File ID | 1：表示為Folder ID -->
    <entryid>{ File ID | Folder ID }</entryid>
</getadvancedsharecode>

<!--?xml version="1.0" encoding="utf-8" ?-->
<getadvancedsharecode>
    <status>{ Status Code }</status>
    <scrip>{ Scrip }</scrip>
    <sharecode>{ 雲端分享碼 }</sharecode>
    <ispasswordneeded>[ 0 | 1 ]</ispasswordneeded>    <!-- 0：不須密碼即可存取 | 1：須輸入密碼 -->
    <isgroupaware>[ 0 | 1 ] </isgroupaware>    <!-- 若為 1 表示支援群組編輯，反之，則不支援 -->
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#1 }</shareforuserid>
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#2 }</shareforuserid>
    <shareforuserid>{ …… }</shareforuserid>
    <shareforuserid>{ 協同合作資料夾被分享者 User ID#N }</shareforuserid>
    <expiredtime>{ yyyy-MM-dd HH:mm:ss。若此欄為空表示未指定逾期時間 }</expiredtime>    <!-- 單位：小時-->
    <folderquota>{ 協同合作資料夾被分享者可上傳檔案的空間上限 }</folderquota>    <!-- 單位：byte -->
</getadvancedsharecode>

此API僅支援「長分享碼」

<!--?xml version="1.0" encoding="utf-8" ?-->
<getinfobysharecode>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <sharecode>{ 雲端分享碼 }</sharecode>
</getinfobysharecode>

<!--?xml version="1.0" encoding="utf-8" ?-->
<getinfobysharecode>
    <status>{ Status Code }</status>
    <entryid>{ File ID | Folder ID }</entryid>
    <entrytype>[ 0 | 1 ] </entrytype>    <!-- 0：表示為File ID | 1：表示為Folder ID -->
</getinfobysharecode>

群組分享功能目前僅支援設定目錄(Folder)為協同合作資料夾。

<!--?xml version="1.0" encoding="utf-8"?-->
<listsharingtoothers>
    <token>{ token }</token>
    <userid>{ 用戶自己的User ID }</userid>
</listsharingtoothers>

<!--?xml version="1.0" encoding="utf-8"?-->
<listsharingtoothers>
    <status>{ Status Code }</status>
    <entry>        <!-- entry element 可以重覆多次 -->
        <entryid>{ Folder ID }</entryid>
        <isfolder>[ 1 ]</isfolder>        <!-- 1：表示 Entry 為 Folder -->
        <rawentryname>{ 目錄名稱 }</rawentryname>
    </entry>
</listsharingtoothers>

群組分享功能目前僅支援設定目錄(Folder)為協同合作資料夾。

<!--?xml version="1.0" encoding="utf-8"?-->
<listsharingfromothers>
    <token>{ token }</token>
    <userid>{ 用戶自己的User ID }</userid>
</listsharingfromothers>

<!--?xml version="1.0" encoding="utf-8"?-->
<listsharingfromothers>
    <status>{ Status Code }</status>
    <entry>        <!-- entry element 可以重覆多次 -->
        <userid>{ 提供協同合作資料夾的用戶 User ID }</userid>
        <entryid>{ Folder ID }</entryid>
        <isfolder>[ 1 ]</isfolder>        <!-- 1：表示Entry為Folder -->
        <rawentryname>{ 目錄名稱 }</rawentryname>
        <ispasswordaccess>[ 0 | 1 ]</ispasswordaccess>        <!-- 此欄表示是否需要密碼才可存取 entry。0：不需要密碼 | 1：需要密碼 --></entry>
</listsharingfromothers>

群組分享功能目前僅支援設定目錄(Folder) 為協同合作資料夾。

<!--?xml version="1.0" encoding="utf-8"?-->
<rejectsharing>
    <token>{ token }</token>
    <entryid>{ 別人分享給自己的協同合作資料夾 Folder ID }</entryid>
</rejectsharing>

<!--?xml version="1.0" encoding="utf-8"?-->
<rejectsharing>
    <status>{ Status Code }</status>
</rejectsharing>

<!--?xml version="1.0" encoding="utf-8"?-->
<deletesharecode>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <entrytype>[ 0 | 1 ]</entrytype>    <!-- 0：目錄 | 1：檔案 -->
    <entryid>{ File ID | Folder ID }</entryid>    <!-- 用戶分享的檔案或目錄 -->
    <password>{ 此欄位為使用者欲防止非授權用戶存取檔案或目錄的密碼。 }</password>    <!-- 選擇性欄位。該參數值須以轉小寫做 MD5 編碼(請參閱註解)後的字串來表示 -->
</deletesharecode>

<!--?xml version="1.0" encoding="utf-8"?-->
<deletesharecode>
    <status>{ Status Code }</status>
    <scrip>{ scrip }</scrip>
</deletesharecode>

<!--?xml version="1.0" encoding="utf-8"?-->
<getsharedentries>
    <userid>{ User ID }</userid>
    <token>{ token }</token>
    <kind>[ 0 | 1 | 2 ]</kind>    <!-- 搜尋目標類型。0：檔案及目錄 | 1：目錄 | 2：檔案 -->
    <pagesize>{ 設定回傳的一頁有多少筆記錄，預設值為 10 }</pagesize>
    <sortby>[ 0 | 1 ]</sortby>    <!-- 0為CreatedTime | 1 為 EntryID -->
    <sortdirection>[ 0 | 1 ]</sortdirection>    <!-- 0 為 ASC | 1為DESC -->
    <firstentrybound>{ 若 sortby為 0，則格式為時間式 yyyy-MM-dd HH:mm:ss:SSS；若 sortby 為 1，則格式為數值型式 ID number。搜尋結果不含此欄指定的值 }</firstentrybound>    <!-- 選擇性欄位。第一次呼叫時不必指定此參數 -->
</getsharedentries>

<!--?xml version="1.0" encoding="utf-8"?-->
<getsharedentries>
    <status>{ Status Code }</status>
    <lastentrybound>{ 本次搜尋結果的最後一筆 entry 的排序欄位內容。可做為下一次呼叫此 API 時的 firstentrybound 參數，藉此實現逐頁瀏覽。本欄位格式請參照輸入參數 firstentrybound }</lastentrybound>    <!-- entry 可重覆多次 -->
    <entry>
        <id>{ File ID | Folder ID }</id>
        <parent>{ Parent Folder ID }</parent>
        <rawentryname>{ 檔案名稱 | 目錄名稱 }</rawentryname>
        <isfolder>[ 0 | 1 ]</isfolder>        <!-- 搜尋結果。0：檔案 | 1：目錄 -->
        <isbackup>[ 0 | 1 ]</isbackup>        <!-- 若為 1 表示是備份的檔案或目錄，否則為一般檔案或目錄 -->
        <sharingavailabletime>{ 格式為yyyy-MM-dd HH:mm:ss:SSS } </sharingavailabletime>
        <createdtime>{ 格式為yyyy-MM-dd HH:mm:ss }</createdtime>
        <lastchangetime>{ 資料型別為長整數，從1970/01/01 00:00:00 到現在為止的毫秒數 }</lastchangetime>        <!-- 目錄無此參數值 -->
        <isorigdeleted>[ 0 | 1 ]</isorigdeleted>        <!-- 0：原始檔未刪除 | 1：原始檔已刪除 -->
        <marks>{ 附屬於此檔案的標示代碼(Mark ID 請參閱註解)。若有多個標示代碼，須以空白字元分隔；若是該檔案沒有任何標示代碼時，則此欄位不出現。 }</marks>
        <attribute>{ Data(請參閱註解) }</attribute>
        <isinfected>[ 0 | 1 ]</isinfected>        <!-- 此欄位用以判斷檔案是否感染病毒。0：表示未感染 | 1：表示已感染 -->
        <size>{ 檔案大小(File Size) }</size>        <!-- 為目錄時此參數不出現-->
        <ispublic>[ 0 | 1 ]</ispublic>        <!-- 使用者是否已設定為分享目錄。0：意指PRIVATE | 1：意指 PUBLIC(已分享) --></entry>
</getsharedentries>

<!--?xml version="1.0" encoding="utf-8"?-->
<checkpassword>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <suri>{ 檢驗是否須輸入密碼方能存取目標的分享碼(Share Code) }</suri>
</checkpassword>

<!--?xml version="1.0" encoding="utf-8"?-->
<checkpassword>
    <status>{ Status Code }</status>
    <ifpassword>[ 0 | 1 ]</ifpassword>    <!-- 1：表示需輸入密碼方能存取具備此分享碼(Share Code) 的檔案 -->
</checkpassword>

<!--?xml version="1.0" encoding="utf-8"?-->
<comparepassword>
    <token>{ token }</token>
    <userid>{ User ID }</userid>
    <isfolder>[ 0 | 1 ]</isfolder>    <!-- 0：表示指定的 ffid 參數值為檔案 ID(File ID) | 1：則表示為目錄 ID(Folder ID) -->
    <ffid>{ File ID | Folder ID }</ffid>
    <passwd>{ 保護被分享檔案的密碼。密碼轉小寫後，再經過 MD5 編碼(請參閱註解) }</passwd>
</comparepassword>

<!--?xml version="1.0" encoding="utf-8"?-->
<checkpassword>
    <status>{ Status Code }</status>
</checkpassword>

屬性(Attribute)

用以儲存檔案／目錄描述資訊，亦可加入各 App 對檔案／目錄獨有的資訊，以 XML 型式儲存，至少須包含以下三個內容：

• creationtime : 建立時間

• lastaccesstime : 最後一次存取時間

• lastwritetime : 最後一次變更時間

• 以上三個時間皆是從1970年至今的秒數。

  Ex： 131305412313130541231313054123

※ 由於 Attribute 內容，除了上述三個時間外，可能因不同應用而加上不同的內容。於修改內容時，請僅針對三個時間，或是您自訂的內容做修改，其他的請務必保留。

合法的標示代碼(Mark ID)

開放客戶端對指定檔案／目錄做特殊的標示記號，用以標註該檔案／目標的特殊意義 (例如：重要或書籤)。

目前 OmniStor 開放標示代碼為：

• 1 表示星號 - 即服務顯示之星號標記

MD5 編碼注意事項

若您的 MD5 編碼未經過十六進制轉換，請務必在MD5編碼過後，再以十六進位轉換。十六進位所使用的「a,b,c,d,e,f」字母須為小寫。