取得資訊

使用者帳戶資訊(/member/getinfo/)

伺服器:ServiceGateway

目的:查詢使用者基本資料及已使用狀況資訊;包括可用空間、已使用空間、可設定備份電腦數、已設定備份電腦數等資訊。

Credential State常數:

  • 30 ENABLED:被 Activate、Enable、Unlock後,可正常使用的狀態。
  • 20 DISABLED:被 Disable,不可使用。
  • 10 LOCKED:輸入 OTP 錯誤過多次,被 VesiSign 鎖定,暫時不可用,直到以 Unlock API解鎖定。
  • 0 INACTIVE:被 Deactivate,不可使用。
  • /member/getinfo/

    Input

    
    <!--?xml version="1.0" encoding="utf-8" ?-->
    <getinfo>
    	<userid>{ User ID }</userid>
    	<token>{ token }</token>
    	<time>{ time stamp, this is for scramble the payload }</time>
    </getinfo>
    							  

    Output

    
    <!--?xml version="1.0" encoding="utf-8" ?-->
    <getinfo>
    	<status>{ Status Code }</status>
    	<account>{ Account ID }</account>
    	<email>{ Email Address }</email>
    	<regyear>{ regYear }</regyear><!-- 此值目前固定為 2008 -->
    	<language>{ zh-tw }</language>
    	<activateddate>{ 啟用時間,格式為 yyyy-MM-dd HH:mm:ss }</activateddate>
    	<credential>{ 用戶的 OTP Credential ID }</credential><!-- 未使用 OTP 機制的用戶此欄為空字串 -->
    	<credentialstate>{ 用戶 OTP Credential ID 的現行狀態 }</credentialstate><!--未使用 OTP 機制的用戶此欄為空字串 -->
    	<usedbackuppc>{ 個數 }</usedbackuppc><!-- 此帳號已使用的備份電腦資料夾個數-->
    	<backuppc><!-- 此 Element 可重覆多次 -->
    		<name>{ 備份電腦的資料夾名稱的 Base64 編碼結果字串 }</name><!-- 若您使用的開發語言為 Ruby,請用 Base64.strict_encode64,避免“\n”在編碼之後出現。-->
    		<createdtime>{ 格式為yyyy-MM-dd HH:mm:ss }</createdtime><!-- 備份電腦建立時間 -->
    	</backuppc>
    	<package>
    			<id>{ Package ID }</id>
    			<display>{ EeePC-20G }</display><!-- package name -->
    			<capacity>{ 容量大小。Ex:20000 }</capacity><!-- 計量單位 MB -->
    			<uploadbandwidth>{ 頻寬。Ex:128 }</uploadbandwidth><!-- 計量單位 KB -->
    			<downloadbandwidth>{ 頻寬。Ex:128 }</downloadbandwidth><!-- 計量單位 KB -->
    			<upload>{ Ex:128 }</upload><!-- 計量單位 MB -->
    			<download>{ Ex:128 }</download><!-- 計量單位 MB -->
    			<concurrentsession>{ # 幾個session(數值) }</concurrentsession>
    			<maxfilesize>{ 檔案上傳容量上限 }</maxfilesize><!-- 單位為 MB -->		
    			<hasencryption>[ 0 | 1 ]</hasencryption>
    			<expire>{ 到期日(格林威治時間),yyyy-MM-dd HH:mm:ss }</expire>
    			<maxbackuppc>{ 備份電腦數上限 }</maxbackuppc>
    			<featurelist>
    				<feature name="{ 功能名稱,例如:MEar }" enable="[ 0 | 1 ]"><!-- feature 可以重覆出現多次描述多個功能項目 -->
    						<property name="{ 功能屬性名稱 }" value="{ 功能屬性值 }"></property><!-- property 可以重覆出現,多次描述多個功能屬性 -->
    				</feature>
    			</featurelist>
    	</package>
    	<usedcapacity>{ 已使用空間 }</usedcapacity><!-- 單位為 MB -->
    	<freecapacity>{ 剩餘可用空間 }</freecapacity><!-- 單位為 MB -->
    </getinfo>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    999 General Error。

    瀏覽目錄(/inforelay/browsefolder/)

    伺服器:InfoRelay

    目的:由客戶端指定欲瀏覽的目錄,伺服端將傳回該目錄下的檔案列表及相關資訊。客戶端亦可將檔案依照名稱或最後修改時間進行升冪排序或者是降冪排序。

    瀏覽顯示:

    1. 傳入參數 pageno 及 pagesize 將可進行分頁(須二參數皆有才有分頁功能)。
    2. 由客戶端指定分頁參數(pageno),以顯示該參數頁面下的檔案資料(record)。若指定的目錄下無任何檔案資料,伺服端將回傳分頁參數(pageno)值為 0。
      • 若輸入分頁參數(pageno)為 1,則伺服端將回傳該目錄下第一頁的檔案資料(record)供客戶端瀏覽。
      • 若輸入分頁參數(pageno)小於 1,則伺服端將會判斷該目錄下是否有任何檔案資料(record)。若有,則伺服端將回傳分頁參數(pageno)為1,以便客戶端瀏覽目錄下第一頁的檔案列表;若查不到任何檔案資料,將回傳分頁參數(pageno)值為 0。
      • 若輸入分頁參數(pageno)數值大於最後一頁,則伺服端將回傳分頁參數(pageno)為最後一頁的頁碼。

    TYPE參數說明:

    參數值 瀏覽顯示結果(副檔名)
    FOLDER 目錄
    DOC html,htm,xml,xls,ppt,doc,xlsx,pptx,docx,odt,ods,odp,pdf,epub,rtf,txt
    IMAGE jpg,gif,png,jpeg,bmp
    VIDEO avi,mp4,mpeg,mpg,m4v,mov,mkv,vob,vcd,svcd,rm,rmvb,divx,wmv,3gp,3gpp,flv
    MUSIC mp3,aac,3gpp,amr
    OTHERS 非以上副檔名的檔案

    /inforelay/browsefolder/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <browse>
    	<token>{ token }</token>
    	<language>{ 使用者的語系,例如:zh_TW }</language>
    	<userid>{ User ID }</userid>
    	<folderid>{ Folder ID }</folderid><!-- 欲瀏覽的目錄ID -->								
    	<type>[ FOLDER | DOC | IMAGE | VIDEO | MUSIC | OTHERS ]</type>
    	<!-- 選擇性欄位。不傳此參數,將顯示所有結果;若輸入固定參數,則可決定要瀏覽顯示子目錄或是特定類別的檔案。詳情請參閱此 API 的「TYPE參數說明」 -->
    	<pageno>{ 要索取的頁面號碼#(第一頁為1)。例如:17 }</pageno>
    	<pagesize>{ 指定一頁要顯示的筆數 }</pagesize>
    	<sortby>[ 1 | 2 ]</sortby><!-- 1:以名稱排序 | 2:以最後修改時間排序 -->
    	<sortdirection>[ 0 | 1 ]</sortdirection><!-- 0:升冪排序(ASC) | 1:降冪排序(DESC) -->
    </browse>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8" ?-->
    <browse>
    	<status>{ Status Code }</status>
    	<rawfoldername>{ 當前瀏覽的目錄名稱 }</rawfoldername>
    	<parent>{ 當前瀏覽目錄的父目錄ID(parent folder ID) }</parent>
    	<rootfolderid>{ 當前瀏覽目錄的根目錄ID(root folder ID) }</rootfolderid>
    	<page>
    		<pageno>{ 當前頁面號碼#(第一頁為1) }</pageno><!-- 當pageno值小於 1 則伺服器回應值為 1;當指定 pageno 大於最大頁數,則伺服器回應為最後一頁 -->
    		<pagesize>{ 當前頁面的子目錄 + 檔案之筆數# }</pagesize>
    		<totalcount>{ 當前瀏覽目錄的子目錄 + 檔案總筆數 }</totalcount>
    		<hasnextpage>[ 0 | 1 ]</hasnextpage>
    	</page>
    	<folder>
    		<id>{ Folder ID }</id>
    		<rawfoldername>{ 目錄名稱 }</rawfoldername>
    		<treesize>{ 該目錄下所有檔案佔用的硬碟空間總和 }</treesize><!-- 單位byte -->
    		<isgroupaware>[ 0 | 1 ]</isgroupaware><!-- 1:已啟用協同合作資料夾功能。詳情請參考「InfoRelay分享功能簡介」的說明 -->
    		<isbackup>[ 0 | 1 ]</isbackup><!-- 若為1表示是備份的檔案或目錄,否則為一般檔案或目錄 -->									
    		<isorigdeleted>[ 0 | 1 ]</isorigdeleted><!-- 0:原始檔未刪除 | 1:原始檔已刪除 -->
    		<ispublic>[ 0 | 1 ]</ispublic><!-- 使用者是否已設定為分享目錄。0:意指PRIVATE | 1:意指PUBLIC(已分享) -->
    		<createdtime>{ yyyy-MM-dd HH:mm:ss }</createdtime><!-- 凡目錄經過移動、更名……等動作後,此參數值皆會更動 -->
    		<markid>{ 附屬於該目錄的標示 ID(Mark ID 請參閱註解),多個標示 ID(Mark ID)之間以空白字元分隔 }</markid>
    	</folder>
    	…
    	<file>
    		<id>{ File ID }</id>
    		<rawfilename>{ 檔案名稱 }</rawfilename>
    		<isgroupaware>[ 0 | 1 ]</isgroupaware><!-- 1:已啟用協同合作資料夾功能。詳情請參考<a href="?p=share&index=5&len=14&id=0&cid=1" ><strong>「InfoRelay 分享功能簡介」</strong></a>的說明 -->
    		<size>{ 檔案大小(File Size) }</size><!-- 單位:byte -->
    		<isbackup>[ 0 | 1 ]</isbackup><!-- 若為1表示是備份的檔案或目錄,否則為一般檔案或目錄 -->
    		<isorigdeleted>[ 0 | 1 ]</isorigdeleted><!-- 0:原始檔未刪除 | 1:原始檔已刪除 -->
    		<isinfected>[ 0 | 1 ]</isinfected><!-- 此欄位用以判斷檔案是否感染病毒。0:表示未感染 | 1:表示已感染 -->
    		<ispublic>[ 0 | 1 ]</ispublic><!-- 使用者是否已設定為分享。0:意指PRIVATE | 1:意指PUBLIC(已分享) -->
    		<headversion>{ 檔案的Version Number# }</headversion>
    		<createdtime>{ yyyy-MM-dd HH:mm:ss }</createdtime><!-- 凡檔案經過移動、更名……等動作後,此參數值皆會更動 -->
    		<markid>{ 附屬於此目錄的標示 ID(Mark ID 請參閱註解),多個標示ID(Mark ID)之間以空白字元分隔 }</markid>
    	</file>
    	…
    	<owner>{ 此目錄的擁有者 }</owner>
    </browse>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 User Authentication Fail。
    218 要處理的目錄不存在或已刪除。
    225 上傳參數錯誤(例如:folderid 參數值未傳)。
    235 上傳參數的操作要求錯誤(例如:sortby 參數值為-1)。
    999 General Error。

    註解

    合法的標示代碼(Mark ID)

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

    目前 OmniStor 開放標示代碼為:

    1. 表示星號。

    最近更新的檔案清單(/file/getlatestchangefiles/)

    伺服器:InfoRelay

    目的:取得用戶最近四周內發生異動的檔案列表(不包含已刪除之檔案)。可利用更新時間做排序。

    /file/getlatestchangefiles/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getlatestchangefiles>
    	<userid>{ User ID }</userid>
    	<token>{ token }</token> 
    	<top>{ 設定回傳幾筆檔案資料 }</top><!-- 預設值為10 -->
    	<targetroot>{ 欲搜尋的系統資料夾 ID(請參閱註解),以逗號分隔 }</targetroot><!-- 該參數不可填入一般資料夾 ID。系統資料夾ID相關說明,請參閱 InfoRelay Technical Spec.pdf 中的「系統資料夾 ID 列表」 -->
    	<sortdirection>[ 0 | 1 ]</sortdirection><!-- 0:升冪排序(ASC) | 1:降冪排序(DESC)。範例:top=30,sortdirection=1,會找出用戶最近更新的、由新排到舊的30筆記錄;top=30,sortdirection=0,會找出用戶最近更新的、由舊排到新的30筆記錄 -->
    </getlatestchangefiles>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getlatestchangefiles>
    	<status>{ Status Code }</status>
    	<entry><!-- entry 可重覆多次 -->
    		<id>{ File ID | Folder ID }</id>
    		<parent>{ Parent Folder ID }</parent>
    		<rawfilename>{ 檔案名稱 }</rawfilename>
    		<isbackup>[ 0 | 1 ]</isbackup><!-- 若為 1 表示是備份的檔案或目錄,否則為一般檔案或目錄 -->
    		<isorigdeleted>[ 0 | 1 ]</isorigdeleted><!-- 0:原始檔未刪除 | 1:原始檔已刪除 -->
    		<marks>{ 附屬於此檔案的標示代碼(Mark ID 請參閱註解)。若有多個標示代碼,須以空白字元分隔;若是該檔案沒有任何標示代碼時,則此欄位不出現。 }</marks>
    		<createdtime>{ 格式為yyyy-MM-dd HH:mm:ss(請參閱註解) }</createdtime>
    		<lastchangetime>{ 資料型別為長整數(請參閱註解) }</lastchangetime>
    		<attribute>{ Data(請參閱註解) }</attribute>
    		<isinfected>[ 0 | 1 ]</isinfected><!-- 此欄位用以判斷檔案是否感染病毒,0:表示未感染 | 1:表示已感染 -->
    		<size>{ 檔案大小(File Size) }</size>
    		<ispublic>[ 0 | 1 ]</ispublic><!-- 使用者是否已設定為分享,0:意指PRIVATE | 1:意指PUBLIC(已分享) -->
    	</entry>
    </getlatestchangefiles>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    3 Payload is not validate。
    225 targetroot參數值須為系統資料夾ID。若為一般資料夾的ID,將會出錯。
    999 General Error。

    註解

    屬性(Attribute)

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

    • creationtime : 建立時間
    • lastaccesstime : 最後一次存取時間
    • lastwritetime : 最後一次變更時間
    • 以上三個時間皆是從1970年至今的秒數。

      Ex: 131305412313130541231313054123

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

    合法的標示代碼(Mark ID)

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

    目前 OmniStor 開放標示代碼為:

    1. 表示星號。

    系統資料夾 ID 列表

    類別 名稱 Folder ID
    system.{package}.home.root 我的收藏 0
    system.backup.root 我的備份 -3
    system.sync.root 同步中心 -5

    ※ 「我的收藏」資料夾:
    {package} 是從 AcquireToken API 所回傳的 XML Payload 中取得,為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

    最近上傳的檔案清單(/file/getlatestuploads/)

    伺服器:InfoRelay

    目的:此 API 可回傳用戶最近上傳之檔案列表。並可利用更新時間進行排序。

    /file/getlatestuploads/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getlatestuploads>
    	<userid>{ User ID }</userid>
    	<token>{ token }</token>
    	<top>{ 設定回傳幾筆檔案資料 }</top><!-- 預設值為 10 -->
    	<targetroot>{ 欲搜尋的系統資料夾ID(請參閱註解),以逗號分隔 }</targetroot><!-- 該參數不可填入一般資料夾 ID。系統資料夾 ID 相關說明,請參閱 InfoRelay Technical Spec.pdf 中的「系統資料夾 ID 列表」-->
    	<sortdirection>[ 0 | 1 ]</sortdirection><!-- 0:升冪排序(ASC) | 1:降冪排序(DESC)。範例:top=30,sortdirection=1,會找出用戶最近上傳的、由新排到舊的30筆記錄;top=30,sortdirection=0,會找出用戶最近上傳的、由舊排到新的30筆記錄 -->
    </getlatestuploads>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getlatestuploads>
    	<status>{ Status Code }</status>
    	<entry><!-- entry 可重覆多次 -->
    		<id>{ File ID | Folder ID }</id>
    		<parent>{ Parent Folder ID }</parent>
    		<rawfilename>{ 檔案名稱 }</rawfilename>
    		<isbackup>[ 0 | 1 ]</isbackup><!-- 若為 1 表示是備份的檔案或目錄,否則為一般檔案或目錄 -->
    		<isorigdeleted>[ 0 | 1 ]</isorigdeleted><!-- 0:原始檔未刪除 | 1:原始檔已刪除 -->
    		<marks>{ 附屬於該檔案的標示代碼(Mark ID 請參閱註解)。若有多個標示代碼,須以空白字元分隔;如果該檔案沒有標示代碼時,則此欄位不出現 }</marks>
    		<createdtime>{ 格式為 yyyy-MM-dd HH:mm:ss(請參閱註解) }</createdtime>
    		<lastchangetime>{ 資料型別為長整數(請參閱註解) }</lastchangetime>
    		<attribute>{ Data(請參閱註解) }</attribute>
    		<isinfected>[ 0 | 1 ]</isinfected><!-- 此欄位用以判斷檔案是否感染病毒。0:表示未感染 | 1:表示已感染 -->
    		<size>{ 檔案大小(File Size) }</size>
    		<ispublic>[ 0 | 1 ]</ispublic><!-- 使用者是否已設定為分享,0:意指PRIVATE | 1:意指PUBLIC(已分享) -->
    	</entry>	
    </getlatestuploads>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    3 Payload is not validate。
    225 targetroot 參數值須為系統資料夾ID。若為一般資料夾的 ID,將會出錯。
    999 General Error。

    註解

    屬性(Attribute)

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

    • creationtime : 建立時間
    • lastaccesstime : 最後一次存取時間
    • lastwritetime : 最後一次變更時間
    • 以上三個時間皆是從1970年至今的秒數。

      Ex: 131305412313130541231313054123

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

    合法的標示代碼(Mark ID)

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

    目前 OmniStor 開放標示代碼為:

    1. 表示星號。

    系統資料夾 ID列表

    類別 名稱 Folder ID
    system.{package}.home.root 我的收藏 0
    system.backup.root 我的備份 -3
    system.sync.root 同步中心 -5

    ※ 「我的收藏」資料夾:
    {package} 是從 AcquireToken API 所回傳的 XML Payload 中取得,為 package 參數中的 display 參數值(請參閱文件「ServiceGateway Technical Spec」)。

    所有資料異動序號(/folder/getallchangeseq/)

    伺服器:InfoRelay

    目的:此 API 可供客戶端查詢用戶的同步資料夾內容是否有異動。

    /folder/getallchangeseq/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getallchangeseq>
    	<token>{ token }</token>
    </getallchangeseq>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getallchangeseq>
    	<status>{ Status Code }</status>
    	<syncfolder><!-- 此 element 可重覆多次 -->	
    		<folderid>{ Folder ID }</folderid>
    		<changeseq>{ Change Sequence }</changeseq>
    	</syncfolder>
    </getallchangeseq>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    999 General Error。

    檔案或目錄相關資料(/fsentry/getentryinfo/)

    伺服器:InfoRelay

    目的:此 API 可供客戶端取得指定檔案/目錄的相關資料,例如:建立時間、上層目錄、屬性、MIME-Type……等。

    /fsentry/getentryinfo/

    Input

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

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getentryinfo>
    	<status>{ Status Code }</status>
    	<isfolder>[ 0 | 1 ]</isfolder><!-- 0:表示為File ID | 1:表示為Folder ID -->
    	<display>{ 經過Base64(UTF-8) 編碼過後的檔案/目錄名稱 }</display><!-- 若您使用的開發語言為 Ruby,請用 Base64.strict_encode64,避免“\n”在編碼之後出現。-->
    	<parent>{ Parent Folder ID }</parent>
    	<isbackup>[ 0 | 1 ]</isbackup> <!-- 若為 1 表示是備份的檔案或目錄,否則為一般檔案或目錄 -->
    	<attribute>{ Data(請參閱註解) }</attribute>
    	<!-- 檔案(File)專屬欄位 begin -->
    	<mimetype>{ 檔案MIME-Type }</mimetype>
    	<isinfected>[ 0 | 1 ]</isinfected><!-- 此欄位用以判斷檔案是否感染病毒。0:表示未感染 | 1:表示已感染 -->	
    	<filesize>{ 單位(bytes) }</filesize>
    	<createdtime>{ 檔案建立時間,格式 yyyy-MM-dd HH:mm:ss(請參閱註解) }</createdtime>
    	<headversion>{ 檔案的Version Number#。}</headversion>
    	<!-- 檔案(File)專屬欄位 end -->
    </getentryinfo>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    218 要處理的目錄不存在或已刪除。
    219 檔案不存在或已刪除。
    999 General Error。

    註解

    屬性(Attribute)

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

    • creationtime : 建立時間
    • lastaccesstime : 最後一次存取時間
    • lastwritetime : 最後一次變更時間
    • 以上三個時間皆是從1970年至今的秒數。

      Ex: 131305412313130541231313054123

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

    查詢檔案、目錄是否存在(/find/propfind/)

    伺服器:InfoRelay

    目的:此 API 可供客戶端查詢檔案/目錄是否存在於指定目錄下。由客戶端指定欲查詢的目錄之下的檔案或子目錄名稱(經 Base64 編碼),若查詢成功可得知檔案或目錄的 ID 及其相關資訊。

    ※ 若您使用的開發語言為 Ruby,請用 Base64.strict_encode64,避免“\n”在編碼之後出現。
    ※ 如欲詳知 OmniStor 系統所提供的分享功能,請參照本文件「分享功能簡介」。

    /find/propfind/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <propfind>
    	<token>{ token }</token>
    	<userid>{ User ID }</userid>
    	<parent>{ Parent Folder ID }</parent>
    	<find>{ 以Base64(UTF-8) 編碼的目錄名稱 }</find><!-- 若您使用的開發語言為 Ruby,請用 Base64.strict_encode64,避免“\n”在編碼之後出現。-->
    	<type>[ system.folder | system.file | system.unknown ]</type>
    	<!-- system.folder指的是查詢目標為目錄;system.file 代表查詢的目標是檔案;system.unknown 則是不限定查詢目標是目錄或是檔案 -->
    	<isshared>[ 0 | 1 ]</isshared> <!-- 選擇性欄位,預設值為 0。若欲查詢的指定目錄(Parent)為他人所分享的目錄,必須將 isshared 設為 1 -->
    </propfind>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <propfind>
    	<status>{ Status Code }</status>
    	<isencrypted>[ 0 | 1 ]</isencrypted>
    	<size>{ 檔案大小(File Size) }</size>
    	<scrip>{ Scrip }</scrip>
    	<type>[ system.folder | system.file | system.notfund ]</type><!-- system.folder 表示搜尋結果是目錄;system.file 代表檔案;system.notfund 則是沒有找到目錄或是檔案 -->
    	<id>{ File ID | Folder ID }</id>
    </propfind>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    225 上傳參數錯誤(例如:userid 參數值未傳)。
    999 General Error。

    檢查目錄是否有使用(/folder/ischildrenexist/)

    伺服器:InfoRelay

    目的:由客戶端指定多個目錄產生查詢目錄列表,並可檢查傳入之目錄列表中的每一個目錄底下是否有檔案或子目錄存在。

    /folder/ischildrenexist/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <ischildrenexist>
    	<token>{ token }</token>
    	<userid>{ User ID }</userid>
    	<folderids>{ Folder ID1,Folder ID 2,Folder ID 3…… }</folderids><!-- 最多200個 -->
    </ischildrenexist>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <ischildrenexist>
    	<status>{ Status Code }</status>
    	<requestfolder>
    		<id>{ Folder ID }</id>
    		<childrenexist>[ 0 | 1 ]</childrenexist><!-- 0:表示該目錄下的沒有檔案或子目錄存在 -->
    	</requestfolder>
    	<requestfolder>
    		<id>{ Folder ID }</id>
    		<childrenexist>[ 0 | 1 ]</childrenexist>
    	</requestfolder>
    	….
    </ischildrenexist>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    225 Illegal Argument。
    999 General Error。

    取得同步資料夾(/folder/getmysyncfolder/)

    伺服器:InfoRelay

    目的:取得同步資料夾(MySyncFolder) 的 Folder ID。若同步資料夾不存在,將自動建立。

    /folder/getmysyncfolder/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getmysyncfolder>
    	<userid>{ User ID }</userid>
    	<token>{ token }</token>
    </getmysyncfolder>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getmysyncfolder>
    	<status>{ Status Code }</status>
    	<id>{ Folder ID }</id>
    </getmysyncfolder>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail。
    999 General Error。

    服務區域 ID 查詢 ServiceGateway位址(/member/acquireservicegateway/)

    伺服器:ServicePortal

    目的:此 API 可供客戶端,以 sid、ProgKey 及服務區域 ID(Service Area ID)查詢 ServiceGateway 的位址(詳情請參閱註解「服務區域ID列表」)。

    ※ 請客戶端務必在 HTTP Header 中提供 sid 及 ProgKey(必須採用 Authorization的 方式,Authorization Header 請參見 ServiceGateway 技術文件的 /member/acquiretoken/)。

    /member/acquireservicegateway/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <acquireservicegateway>
    		<areaid>[ 服務區域 ID(Service Area ID) ]</areaid>
    </acquireservicegateway>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <acquireservicegateway>
    		<status>{ Status Code }</status>
    		<servicegateway>{ ServiceGateway 位址 }</servicegateway>
    </acquireservicegateway>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail(例如:系統找不到長分享碼或是短分享碼有誤導至解碼失敗)。
    5 Developer Authentication Fail(例如:sid 不存在或 ProgKey 驗證失敗)。
    253 Object not found(例如:查無此 Service Area ID 所對應的 ServiceGateway)。
    501 Illeagl State(例如:xml 的語法不正確)。
    999 General Error。

    註解

    服務區域ID列表

    服務區域ID 服務區域
    1 台灣
    2 美國
    3 大陸

    取得用戶個人系統資料夾(/folder/getpersonalsystemfolder/)

    伺服器:InfoRelay

    目的:此API可供客戶端取得指定用戶(User ID)的個人系統資料夾ID(Personal System Folder ID)。請參閱註解「個人系統資料夾名稱列表」。

    /folder/getpersonalsystemfolder/

    Input

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getpersonalsystemfolder>
    	<token>{ token }</token>
    	<userid>{ User ID }</userid>
    	<rawfoldername>[ 個人系統資料夾的名稱。例如:MyRecycleBin ]</rawfoldername>
    </getpersonalsystemfolder>
                                 

    Output

    
    <!--?xml version="1.0" encoding="utf-8"?-->
    <getpersonalsystemfolder>
    	<status>{ Status Code }</status>
    	<scrip>{ scrip }</scrip>
    	<folderid>{ 個人系統資料夾的 ID(Personal System Folder ID) }</folderid>
    </getpersonalsystemfolder>
    							  

    回傳的狀態碼(Status Code)


    0 Success。
    2 Authentication Fail
    3 Payload is not validate。
    225 參數值不在容許的定義域內(例如:不存在的個人系統資料夾名稱)。
    999 General Error。

    註解

    個人系統資料夾名稱列表

    個人系統資料夾 名稱
    MyRecycleBin 資源回收筒