Skip to content

Latest commit

 

History

History
137 lines (90 loc) · 3.93 KB

BulkSendJobApi.md

File metadata and controls

137 lines (90 loc) · 3.93 KB
Raw

Dropbox\Sign\BulkSendJobApi

All URIs are relative to https://api.hellosign.com/v3.

Method HTTP request Description
bulkSendJobGet() GET /bulk_send_job/{bulk_send_job_id} Get Bulk Send Job
bulkSendJobList() GET /bulk_send_job/list List Bulk Send Jobs

bulkSendJobGet()

bulkSendJobGet($bulk_send_job_id, $page, $page_size): \Dropbox\Sign\Model\BulkSendJobGetResponse

Get Bulk Send Job

Returns the status of the BulkSendJob and its SignatureRequests specified by the bulk_send_job_id parameter.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config);

$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174";

try {
    $result = $bulkSendJobApi->bulkSendJobGet($bulkSendJobId);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
bulk_send_job_id string The id of the BulkSendJob to retrieve.
page int Which page number of the BulkSendJob list to return. Defaults to 1. [optional] [default to 1]
page_size int Number of objects to be returned per page. Must be between 1 and 100. Default is 20. [optional] [default to 20]

Return type

\Dropbox\Sign\Model\BulkSendJobGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bulkSendJobList()

bulkSendJobList($page, $page_size): \Dropbox\Sign\Model\BulkSendJobListResponse

List Bulk Send Jobs

Returns a list of BulkSendJob that you can access.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config);

$page = 1;
$pageSize = 20;

try {
    $result = $bulkSendJobApi->bulkSendJobList($page, $pageSize);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name Type Description Notes
page int Which page number of the BulkSendJob List to return. Defaults to 1. [optional] [default to 1]
page_size int Number of objects to be returned per page. Must be between 1 and 100. Default is 20. [optional] [default to 20]

Return type

\Dropbox\Sign\Model\BulkSendJobListResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]