2014-06-16 58 views
0

我們使用API​​從信封中檢索數據,主要是文本標籤,但我們需要的其中一個字段是品牌。我已經看到創建信封時可以設置brandId的位置,但是在信封上進行GET時可以使用此數據嗎?使用REST API可以爲品牌檢索品牌ID嗎?

回答

0

我不知道任何方式檢索brandId爲現有的信封,並沒有在DocuSign REST API指南中提到這種可能性。

一個變通辦法是使用一個「定製信封字段」(類型=文本)來存儲brandId與當創建信封信封相關聯的一段元數據。例如,要設置(文本)自定義信封字段中創建信封存儲品牌標識API請求時,你可以簡單地包括這種結構的創建信封API請求的一部分:

"customFields":{ 
    "textCustomFields":[ 
     { 
      "name":"envBrandId", 
      "required":"false", 
      "show":"false", 
      "value":"XXXX-XX-XXXX-XX-XXXX" 
     } 
    ] 
} 

見DocuSign REST API指南(https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/rest-api-guide-v2.pdf)瞭解更多詳情。

然後,一旦信封已經創建,您可以通過使用該請求獲取自定義信封字段(一個或多個)的值(S):再次

GET /accounts/{accountId}/envelopes/{envelopeId}/custom_fields 

的REST API指南包含有關細節這個操作。

+0

這就是我的想法。由於我們希望保持API調用的數量不變,因此我們可能會使用文本選項卡而不是自定義字段,因爲我們已經獲取了收件人選項卡並且當前沒有調用自定義字段。 –

+0

當然,這將工作。僅供參考 - 您可以通過設置字體顏色以匹配頁面背景的顏色來「隱藏」文本選項卡的值(即,使文本在文檔中不可見)。例如,如果頁面爲白色,則將文本選項卡的字體顏色設置爲白色 - 並且在文檔中不可見。但要注意標籤在文檔中的放置位置 - 因爲即使文本的字體顏色與頁面相匹配,該文本也不會顯示,但仍會佔用文本所需的空間 - 可能會掩蓋/覆蓋文檔中的其他內容。 –