本文件是iShare系统所提供的网站人员管理API的规格文件....docVIP

iShare Portal User API Specification 目錄 說明 1 誰適合閱讀 1 文件歷史 1 認證模式 2 Interface 定義 2 UserModify 2 UserGetInfo 3 UserGetList 4 UserAuthenticate 5 UserEmail 5 Interface 範例 6 UserModify 6 UserGetInfo 8 UserGetList 9 UserAuthenticate 10 UserEmail 10 錯誤訊息 12 說明 本文件是iShare系統所提供的網站人員管理API的規格文件。 誰適合閱讀 系統整合工程師 系統測試工程師 文件歷史 日期 作者 說明 1.0 2007/01/12 呂美君 提供 API 功能。 認證模式 當網站建立後, 系統會產生網站認證碼並寄給網站管理員。 同時系統會註冊相關的伺服器位址。 外接系統使用iShare的網站人員管理API需帶入註冊的網站名稱跟認證碼。 只有經過認證碼和伺服器位址檢查後的request才會被進一步處理 Interface 定義 interface輸入參數跟輸出結果的列表。 參數以 XML 的格式做處理。 請注意所有的時間都是以相關網站的時區表示。 如需更改時區，請洽系統管理員。 UserModify 新增，更新或刪除相關網站中人員的基本資料。 類型 Tag 資料型態 註解 PortalName String 是 網站名稱。 PortalKey String 是 Users 否 UserInfo UserInfo 是 UserInfo Action Integer 是 值: , 1 = 更新, 2 = 刪除。 Username String 是 登入帳號 格式: 英文字母, 數字。 以下參數只適用於新增或更新。 Password String 依狀況 登入密碼 格式: 英文字母, 數字。 新增時為必要參數。 更新時如輸入值是空白, 系統會使用預設值預設值: Password。 FullName String 依狀況 姓名 新增時為必要參數。 更新時如輸入值是空白, 系統會使用預設值預設值: FullName。 Email String 依狀況 電子郵件 新增時為必要參數。 更新時如輸入值是空白, 系統會使用預設值預設值: Email。 Gender Integer 否 性別 值: 男, 預設值: Gender。 Telephone String 否 聯絡電話 預設值: Telephone。 Cellphone String 否 行動電話 預設值: Cellphone。 Region String 否 聯絡地址州/省 預設值: Region。 PostalCode String 否 聯絡地址郵遞區號 預設值: PostalCode。 Street String 否 聯絡地址地址 預設值: Street。 Group String 否 所屬組織預設值預設值: default, 更新 - 現有的Group。 BirthDate DateTime 否 出生日期: YYYY-MM-DD。 預設值: BirthDate。 ExpiryDate DateTime 否 使用期限 如輸入值是空白，為無截止期限。 格式: YYYY-MM-DD。 預設值: , 更新 - 現有的ExpiryDate。 PreferredLanguage String 否 偏好語言預設值值: , zh-TW。 預設值: 語言, 更新 - 現有的PreferredLanguage。 TimezoneOffset Integer 否 時區預設值 預設值: , 更新 - 現有的TimezoneOffset。 輸出結果 Results 否 Result Result 是 Result Username String 是 登入帳號 UserID Guid 否 (系統産生)。 格式: 324個連字號(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) CreationStatus 是 CreationStatus Status String 是 Message String 否 UserGetInfo 取得相關網站中某個人員的資訊。 類型 Tag 資料型態 註解 PortalName String 是 網站名稱。 PortalKey String 是 SearchBy