listStatus端点包括响应中的收件人状态 [英] listStatus endpoint include recipient status in response

问题描述

是否有一种方法可以在listStatus端点的响应正文中包括收件人状态？

Is there a way to include the recipient statuses in the response body for the listStatus endpoint?

这是我正在进行的卷曲请求

Here is the curl request I am making

curl -X PUT \
  https://na2.docusign.net/restapi/v2/accounts/XXXXX/envelopes/status?envelope_ids=request_body \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-DocuSign-Authentication: { ... }' \
  -d '{
    "envelopeIds": [
        "SOME ENVELOPE ID",
        "ANOTHER ENVELOPE ID"
    ]
  }'

这是我得到的结果

{
    "resultSetSize": "76",
    "totalSetSize": "76",
    "startPosition": "0",
    "endPosition": "75",
    "nextUri": "",
    "previousUri": "",
    "envelopes": [
        {
            "status": "sent",
            "documentsUri": "/envelopes/XXXX/documents",
            "recipientsUri": "/envelopes/XXXX/recipients",
            "attachmentsUri": "/envelopes/XXXX/attachments",
            "envelopeUri": "/envelopes/XXXX",
            "envelopeId": "XXXX",
            "customFieldsUri": "/envelopes/XXXX/custom_fields",
            "notificationUri": "/envelopes/12da3965-99cb-4c2d-9d3d-587a32fca118/notification",
            "statusChangedDateTime": "2017-08-07T14:34:38.4530000Z",
            "documentsCombinedUri": "/envelopes/XXXX/documents/combined",
            "certificateUri": "/envelopes/XXXX/documents/certificate",
            "templatesUri": "/envelopes/XXXX/templates"
        },
        ...
    ]
}

在文档页面，它显示了一个示例包括

In the documentation page, it shows an example response that includes

{
    "resultSetSize": "76",
    "totalSetSize": "76",
    "startPosition": "0",
    "endPosition": "75",
    "nextUri": "",
    "previousUri": "",
    "envelopes": [
        {
            "status": "sent",
            "documentsUri": "/envelopes/XXXX/documents",
            "recipientsUri": "/envelopes/XXXX/recipients",
            "attachmentsUri": "/envelopes/XXXX/attachments",
            "envelopeUri": "/envelopes/XXXX",
            "envelopeId": "XXXX",
            "customFieldsUri": "/envelopes/XXXX/custom_fields",
            "notificationUri": "/envelopes/12da3965-99cb-4c2d-9d3d-587a32fca118/notification",
            "statusChangedDateTime": "2017-08-07T14:34:38.4530000Z",
            "documentsCombinedUri": "/envelopes/XXXX/documents/combined",
            "certificateUri": "/envelopes/XXXX/documents/certificate",
            "templatesUri": "/envelopes/XXXX/templates",
            "recipients": {
              "signers": [
                {
                   "status": "sent",
                   ...
                }
              ]
            },
        },
        ...
    ]
}

我不确定我需要对原始请求进行哪些操作以包含收件人在响应部分。有谁知道我是否缺少某种url参数或body参数或某些东西？

I am not sure what I need to do to my original request to includes that recipients section in the response. Does anyone know if I am missing some kind of url param or body param or something?

推荐答案

在<一个href = https://docs.docusign.com/esign/restapi/Envelopes/Envelopes/listStatus/#/definitions/Envelopes rel = nofollow noreferrer>信封：listStatus 端点，似乎是响应您在示例JSON中看到的是Swagger为 Envelope 类自动创建的。如果您想在一个呼叫中查看所有详细信息，则需要使用以下端点对每个信封进行呼叫，

This is not possible in the Envelopes: listStatus endpoint, it seems the response which you are seeing in sample JSON is autocreated by Swagger for the Envelope class. If you want to see all the details in one call then you need to make such call for each envelope using below endpoint,

/restapi/v2/accounts/{{AccountIdVal}}/envelopes/{envelopeId}?include=custom_fields,recipients,tabs&advanced_update=true

这篇关于listStatus端点包括响应中的收件人状态的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！