C / DocuSign eSignature REST API / Gets the envelope status for the specified envelopes.
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "envelopeIds": [
// "sample string 1"
// ],
// "transactionIds": [
// "sample string 1"
// ]
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"envelopeIds[0]","sample string 1");
CkJsonObject_UpdateString(json,"transactionIds[0]","sample string 1");
// Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_putAuthToken(http,"{{accessToken}}");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/status?ac_status={{ac_status}}&block={{block}}&count={{count}}&email={{email}}&envelope_ids={{envelope_ids}}&from_date={{from_date}}&from_to_status={{from_to_status}}&start_position={{start_position}}&status={{status}}&to_date={{to_date}}&transaction_ids={{transaction_ids}}&user_name={{user_name}}",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
printf("%d\n",CkHttpResponse_getStatusCode(resp));
printf("%s\n",CkHttpResponse_bodyStr(resp));
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
}
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"envelopeIds": [
"sample string 1"
],
"transactionIds": [
"sample string 1"
]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/status?ac_status={{ac_status}}&block={{block}}&count={{count}}&email={{email}}&envelope_ids={{envelope_ids}}&from_date={{from_date}}&from_to_status={{from_to_status}}&start_position={{start_position}}&status={{status}}&to_date={{to_date}}&transaction_ids={{transaction_ids}}&user_name={{user_name}}
Postman Collection Item JSON
{
"name": "Gets the envelope status for the specified envelopes.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"envelopeIds\": [\n \"sample string 1\"\n ],\n \"transactionIds\": [\n \"sample string 1\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/status?ac_status={{ac_status}}&block={{block}}&count={{count}}&email={{email}}&envelope_ids={{envelope_ids}}&from_date={{from_date}}&from_to_status={{from_to_status}}&start_position={{start_position}}&status={{status}}&to_date={{to_date}}&transaction_ids={{transaction_ids}}&user_name={{user_name}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"envelopes",
"status"
],
"query": [
{
"key": "ac_status",
"value": "{{ac_status}}"
},
{
"key": "block",
"value": "{{block}}"
},
{
"key": "count",
"value": "{{count}}"
},
{
"key": "email",
"value": "{{email}}"
},
{
"key": "envelope_ids",
"value": "{{envelope_ids}}"
},
{
"key": "from_date",
"value": "{{from_date}}"
},
{
"key": "from_to_status",
"value": "{{from_to_status}}"
},
{
"key": "start_position",
"value": "{{start_position}}"
},
{
"key": "status",
"value": "{{status}}"
},
{
"key": "to_date",
"value": "{{to_date}}"
},
{
"key": "transaction_ids",
"value": "{{transaction_ids}}"
},
{
"key": "user_name",
"value": "{{user_name}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
}
]
},
"description": "Retrieves the envelope status for the specified envelopes."
},
"response": [
]
}