PUT api/ApprovalFlow/ConfirmEnvelope

Confirm envelope configuration and initiates docusign approval flow

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ApprovalFlowId	integer	None.
ApprovalFlowEntityId	integer	None.
EntityId	integer	None.
EntityVersionId	integer	None.
ProjectId	integer	None.
SubcontractId	integer	None.
Files	Collection of ApprovalFlowDocumentDto	None.

Request Formats

application/json, text/json

Sample:

{
  "approvalFlowId": 1,
  "approvalFlowEntityId": 2,
  "entityId": 3,
  "entityVersionId": 1,
  "projectId": 4,
  "subcontractId": 5,
  "files": [
    {
      "id": 1,
      "documentId": 2,
      "name": "sample string 3",
      "currentVersion": 4,
      "isPrincipal": true,
      "isAdditional": true,
      "steps": [
        {
          "stepNumber": 1,
          "mustView": true,
          "mustRead": true,
          "mustAccept": true,
          "signatures": [
            {
              "pageNumber": 1,
              "coordinatePosition": null
            },
            {
              "pageNumber": 1,
              "coordinatePosition": null
            }
          ]
        },
        {
          "stepNumber": 1,
          "mustView": true,
          "mustRead": true,
          "mustAccept": true,
          "signatures": [
            {
              "pageNumber": 1,
              "coordinatePosition": null
            },
            {
              "pageNumber": 1,
              "coordinatePosition": null
            }
          ]
        }
      ],
      "fileSize": 1,
      "fileSizeKb": 0.0009765625,
      "fileSizeMb": 9.5367431640625E-07
    },
    {
      "id": 1,
      "documentId": 2,
      "name": "sample string 3",
      "currentVersion": 4,
      "isPrincipal": true,
      "isAdditional": true,
      "steps": [
        {
          "stepNumber": 1,
          "mustView": true,
          "mustRead": true,
          "mustAccept": true,
          "signatures": [
            {
              "pageNumber": 1,
              "coordinatePosition": null
            },
            {
              "pageNumber": 1,
              "coordinatePosition": null
            }
          ]
        },
        {
          "stepNumber": 1,
          "mustView": true,
          "mustRead": true,
          "mustAccept": true,
          "signatures": [
            {
              "pageNumber": 1,
              "coordinatePosition": null
            },
            {
              "pageNumber": 1,
              "coordinatePosition": null
            }
          ]
        }
      ],
      "fileSize": 1,
      "fileSizeKb": 0.0009765625,
      "fileSizeMb": 9.5367431640625E-07
    }
  ]
}

text/html

Sample:

{"approvalFlowId":1,"approvalFlowEntityId":2,"entityId":3,"entityVersionId":1,"projectId":4,"subcontractId":5,"files":[{"id":1,"documentId":2,"name":"sample string 3","currentVersion":4,"isPrincipal":true,"isAdditional":true,"steps":[{"stepNumber":1,"mustView":true,"mustRead":true,"mustAccept":true,"signatures":[{"pageNumber":1,"coordinatePosition":null},{"pageNumber":1,"coordinatePosition":null}]},{"stepNumber":1,"mustView":true,"mustRead":true,"mustAccept":true,"signatures":[{"pageNumber":1,"coordinatePosition":null},{"pageNumber":1,"coordinatePosition":null}]}],"fileSize":1,"fileSizeKb":0.0009765625,"fileSizeMb":0.00000095367431640625},{"id":1,"documentId":2,"name":"sample string 3","currentVersion":4,"isPrincipal":true,"isAdditional":true,"steps":[{"stepNumber":1,"mustView":true,"mustRead":true,"mustAccept":true,"signatures":[{"pageNumber":1,"coordinatePosition":null},{"pageNumber":1,"coordinatePosition":null}]},{"stepNumber":1,"mustView":true,"mustRead":true,"mustAccept":true,"signatures":[{"pageNumber":1,"coordinatePosition":null},{"pageNumber":1,"coordinatePosition":null}]}],"fileSize":1,"fileSizeKb":0.0009765625,"fileSizeMb":0.00000095367431640625}]}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfBoolean

Name	Type	Additional information
Data	boolean	None.
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.