new module:api/AccountsApi(apiClient)
- Source:
Constructs a new AccountsApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, |
Methods
createBulkClickwrapAgreements(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Starts an export of clickwrap agreements for a specified date range.
Starts an asynchronus process to export clickwrap agreements for a specified date range.
An email will be sent to the creator after it has been processed.
Required authentication scopes: click.manage
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~createBulkClickwrapAgreementsCallback | The callback function, accepting three arguments: error, data, response |
createClickwrap(accountId, optsOrCallback, callback)
- Source:
Creates a clickwrap for an account.
Creates a clickwrap for an account.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~createClickwrapCallback | The callback function, accepting three arguments: error, data, response |
createClickwrapVersion(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Creates a new clickwrap version.
Creates a new version of an existing clickwrap. In a new version, you can replace the uploaded documents, change the display settings, and change the name of the clickwrap. The version number is automatically incremented based on the last version of the clickwrap.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~createClickwrapVersionCallback | The callback function, accepting three arguments: error, data, response |
createHasAgreed(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Creates a unique URL for the agreement that you can embed in your application.
Creates a unique URL for the agreement
that you can embed in your application.
Required authentication scopes: click.manage and click.send.
The request must include at least the
clientUserId. This is a value that you
generate to identify the unique recipient
of the agreement.
If you are using a dynamic content document,
you can supply the values in the documentData
property of the request, like this:
{
"clientUserId": "cl-bc7f-48a9",
"documentData": {
"fullName": "T. J. Fanning",
"email": "tj@example.com",
"company": "Fanning Indusdtries",
"title": "Cat wrangler",
"date": "2022-10-13T05:17:14-07:00"
}
}
A response will look like this.
The agreementUrl is unique to the user identified by the clientUserId.
Your user can open the URL to approve the agreement.
The documentData property appears only if you provided it in the request.
{
"accountId": "624e3e00-xxxx-xxxx-xxxx-43918c520dab",
"clickwrapId": "0e64e4a7-xxxx-xxxx-xxxx-ce5a93b162af",
"clientUserId": "tcl-bc7f-48a9j",
"agreementId": "1f346c7d-xxxx-xxxx-xxxx-a5c968666785",
"documents": [ . . .],
"consumerDisclosureEnabled": true,
"agreementUrl": "https://demo.docusign.net/clickapi/v1/redeem?agreementToken=AcTZT8g ... cxEqrUsA1lQ8DPPy05dE0",
"createdOn": "2022-10-20T16:27:25.1287685Z",
"status": "created",
"versionId": "5957716d-xxxx-xxxx-xxxx-e1594f00ff12",
"versionNumber": 1,
"settings": {
"displayName": "Agree with me",
"hasDeclineButton": true,
. . .
"statementAlignment": "bottom"
},
"documentData": {
"fullName": "T. J. Fanning",
"email": "tj@example.com",
"company": "Fanning Indusdtries",
"title": "Cat wrangler",
"date": "2022-10-13T05:17:14-07:00"
}
}
This method returns the following
result codes and response bodies
depending on whether the user has agreed.
| Agreed | Response code | Response body |
|---|---|---|
| No | 201 | Full response as above |
| Yes | 200 | No response (empty) |
Related topics
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~createHasAgreedCallback | The callback function, accepting three arguments: error, data, response |
deleteClickwrap(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Deletes a clickwrap and all of its versions.
Deletes the clickwrap specified by clickwrapId and all of its versions.
Active clickwraps are not deleted
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~deleteClickwrapCallback | The callback function, accepting three arguments: error, data, response |
deleteClickwraps(accountId, optsOrCallback, callback)
- Source:
Deletes clickwraps for an account.
Deletes all clickwraps for an account
or only the ones specified in the
clickwrapIds query parameter.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~deleteClickwrapsCallback | The callback function, accepting three arguments: error, data, response |
deleteClickwrapVersion(accountId, clickwrapId, versionId, callback)
- Source:
Deletes a clickwrap version by version ID.
Deletes the clickwrap version specified by versionId of the clickwrap specified by clickwrapId.
Note:* This endpoint requires the version ID (a GUID), not the version number (an integer).
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
clickwrapId |
String | The ID of the clickwrap. |
versionId |
String | The ID of the clickwrap version. |
callback |
module:api/AccountsApi~deleteClickwrapVersionCallback | The callback function, accepting three arguments: error, data, response |
deleteClickwrapVersions(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Deletes the versions of a clickwrap.
Deletes all versions of a clickwrap,
or only the ones specified in the
clickwrapVersionIds query parameter.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~deleteClickwrapVersionsCallback | The callback function, accepting three arguments: error, data, response |
getAgreement(accountId, clickwrapId, agreementId, callback)
- Source:
Gets a specific agreement for a specified clickwrap.
Gets the agreement specified by agreementId.
Required authentication scopes: click.manage or click.send.
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
clickwrapId |
String | The ID of the clickwrap. |
agreementId |
String | The agreement ID. |
callback |
module:api/AccountsApi~getAgreementCallback | The callback function, accepting three arguments: error, data, response |
getAgreementDocument(accountId, clickwrapId, versionId, orderOrDisclosure, callback)
- Source:
Downloads a document at an order within the agreement.
Downloads a specific document from the agreement presented to the user.
Required authentication scopes: click.sign
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
clickwrapId |
String | The ID of the clickwrap. |
versionId |
String | The ID of the clickwrap version. |
orderOrDisclosure |
String | The order of the document or consumer_disclosure. |
callback |
module:api/AccountsApi~getAgreementDocumentCallback | The callback function, accepting three arguments: error, data, response |
getAgreementPdf(accountId, clickwrapId, agreementId, optsOrCallback, callback)
- Source:
Gets the completed user agreement PDF.
Gets the PDF of agreementId for the clickwrap specified by clickwrapId.
The response to this method is the bytes of the PDF file.
The response includes the HTTP header application/pdf.
Required authentication scopes: click.manage or click.send.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
agreementId |
String | The agreement ID. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~getAgreementPdfCallback | The callback function, accepting three arguments: error, data, response |
getClickwrap(accountId, clickwrapId, callback)
- Source:
Gets a single clickwrap object.
Retrieves the definition of the specified clickwrap.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
clickwrapId |
String | The ID of the clickwrap. |
callback |
module:api/AccountsApi~getClickwrapCallback | The callback function, accepting three arguments: error, data, response |
getClickwrapAgreements(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Get user agreements
Retrieves the user agreements for a specified clickwrap. Each userAgreementResponse object describes a single user's response to the clickwrap. You can also filter the agreements by date, status, page number, and client user ID.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||||||||||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||||||||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||||||||||||||
callback |
module:api/AccountsApi~getClickwrapAgreementsCallback | The callback function, accepting three arguments: error, data, response |
getClickwraps(accountId, optsOrCallback, callback)
- Source:
Gets all the clickwraps for a user.
Gets all the clickwraps for a user.
Note:* This endpoint returns a list of clickwrapVersionSummaryResponse objects. Each version of each clickwrap is returned as a separate entry in the list.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||||||||||||||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||||||||||||||||||||
callback |
module:api/AccountsApi~getClickwrapsCallback | The callback function, accepting three arguments: error, data, response |
getClickwrapVersion(accountId, clickwrapId, versionId, callback)
- Source:
Gets a specific version of a clickwrap by version ID.
Gets the version specified by versionId from the clickwrap clickwrapId.
Note:* This endpoint requires the version ID (a GUID), not the version number (an integer).
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
clickwrapId |
String | The ID of the clickwrap. |
versionId |
String | The ID of the clickwrap version. |
callback |
module:api/AccountsApi~getClickwrapVersionCallback | The callback function, accepting three arguments: error, data, response |
getClickwrapVersionAgreements(accountId, clickwrapId, versionId, optsOrCallback, callback)
- Source:
Gets the agreement responses for a clickwrap version by version ID.
Gets the agreement responses for a specific version.
Note:* This endpoint requires the version ID (a GUID), not the version number (an integer).
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||||||||||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||||||||||||||
versionId |
String | The ID of the clickwrap version. |
||||||||||||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||||||||||||||
callback |
module:api/AccountsApi~getClickwrapVersionAgreementsCallback | The callback function, accepting three arguments: error, data, response |
getClickwrapVersions(accountId, clickwrapId, callback)
- Source:
Gets all the versions of a clickwrap.
Gets all the versions of a clickwrap for an account.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
clickwrapId |
String | The ID of the clickwrap. |
callback |
module:api/AccountsApi~getClickwrapVersionsCallback | The callback function, accepting three arguments: error, data, response |
getServiceInformation(callback)
- Source:
Gets the current version and other information about the Click API.
The response includes information about the Click API, including the service version, build version, and linked sites.
This method does not require authentication.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
module:api/AccountsApi~getServiceInformationCallback | The callback function, accepting three arguments: error, data, response |
updateClickwrap(accountId, clickwrapId, optsOrCallback, callback)
- Source:
Update a clickwrap by ID.
Update a subset of properties on the clickwrap.
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~updateClickwrapCallback | The callback function, accepting three arguments: error, data, response |
updateClickwrapVersion(accountId, clickwrapId, versionId, optsOrCallback, callback)
- Source:
Updates clickwrap version status and ownership.
Updates the clickwrap version status and ownership by transferring from previous user ID to new user ID.
Note:* This endpoint requires the version ID (a GUID), not the version number (an integer).
Required authentication scopes: click.manage.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID GUID. |
||||||
clickwrapId |
String | The ID of the clickwrap. |
||||||
versionId |
String | The ID of the clickwrap version. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/AccountsApi~updateClickwrapVersionCallback | The callback function, accepting three arguments: error, data, response |
Type Definitions
createBulkClickwrapAgreementsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the createBulkClickwrapAgreements operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
This operation does not return a value. |
|
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
createClickwrapCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the createClickwrap operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionSummaryResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
createClickwrapVersionCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the createClickwrapVersion operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionSummaryResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
createHasAgreedCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the createHasAgreed operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/UserAgreementResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
deleteClickwrapCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the deleteClickwrap operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionsDeleteResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
deleteClickwrapsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the deleteClickwraps operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapsDeleteResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
deleteClickwrapVersionCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the deleteClickwrapVersion operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionDeleteResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
deleteClickwrapVersionsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the deleteClickwrapVersions operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionsDeleteResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getAgreementCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getAgreement operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/UserAgreementResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getAgreementDocumentCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getAgreementDocument operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/Document | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getAgreementPdfCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getAgreementPdf operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Object | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getClickwrapAgreementsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getClickwrapAgreements operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapAgreementsResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getClickwrapCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getClickwrap operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getClickwrapsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getClickwraps operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionsResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getClickwrapVersionAgreementsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getClickwrapVersionAgreements operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapAgreementsResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getClickwrapVersionCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getClickwrapVersion operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getClickwrapVersionsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getClickwrapVersions operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionsPagedResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getServiceInformationCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getServiceInformation operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ServiceInformation | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
updateClickwrapCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the updateClickwrap operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionSummaryResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
updateClickwrapVersionCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the updateClickwrapVersion operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/ClickwrapVersionSummaryResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |