Конечная точка listStatus включает статус получателя в ответ

Question

Есть ли способ включить статусы получателей в тело ответа для конечной точки listStatus?

Вот запрос скручивания, который я делаю

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"
        },
        ...
    ]
}

На странице документации ,он показывает пример ответа, который включает

{
    "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",
                   ...
                }
              ]
            },
        },
        ...
    ]
}

Я не уверен, что мне нужно сделать с моим исходным запросом, чтобы включить этот раздел recipients в ответ.Кто-нибудь знает, если я пропускаю какой-то параметр url или param тела или что-то еще?

Answer 1

Это невозможно в конечной точке Envelopes: listStatus . Похоже, что ответ, который вы видите в примере JSON, автоматически создается Swagger для класса Envelope.Если вы хотите увидеть все детали за один звонок, вам нужно сделать такой звонок для каждого конверта, используя указанную ниже конечную точку,

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