POST api/process/approval/sign

Request Information

URI Parameters

None.

Body Parameters

ApprovalSigningRequest
NameDescriptionTypeAdditional information
ProcessActivityApprovalID

integer

None.

ProcessID

integer

None.

ProcessDetailID

integer

None.

Signature

Collection of byte

None.

Label

string

None.

UserID

integer

None.

UseUserDigitalSignature

boolean

None.

UseGroupDigitalSignature

boolean

None.

IsSignatureFromProfile

boolean

None.

Password

string

None.

Extras

Collection of ApprovalSigningText

None.

Items

Collection of ApprovalSigningInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "ProcessActivityApprovalID": 1,
  "ProcessID": 2,
  "ProcessDetailID": 3,
  "Signature": "QEA=",
  "Label": "sample string 4",
  "UserID": 5,
  "UseUserDigitalSignature": true,
  "UseGroupDigitalSignature": true,
  "IsSignatureFromProfile": true,
  "Password": "sample string 9",
  "Extras": [
    {
      "PageNo": 1,
      "X": 2,
      "Y": 3,
      "Type": 0,
      "Value": "sample string 4"
    },
    {
      "PageNo": 1,
      "X": 2,
      "Y": 3,
      "Type": 0,
      "Value": "sample string 4"
    }
  ],
  "Items": [
    {
      "AttachmentID": 1,
      "PageNo": 2,
      "X": 3,
      "Y": 4,
      "Width": 5,
      "Height": 6,
      "PageWidth": 7,
      "PageHeight": 8
    },
    {
      "AttachmentID": 1,
      "PageNo": 2,
      "X": 3,
      "Y": 4,
      "Width": 5,
      "Height": 6,
      "PageWidth": 7,
      "PageHeight": 8
    }
  ]
}

application/xml, text/xml

Sample:
<ApprovalSigningRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PTI.AF">
  <Extras>
    <ApprovalSigningText>
      <PageNo>1</PageNo>
      <Type>Label</Type>
      <Value>sample string 4</Value>
      <X>2</X>
      <Y>3</Y>
    </ApprovalSigningText>
    <ApprovalSigningText>
      <PageNo>1</PageNo>
      <Type>Label</Type>
      <Value>sample string 4</Value>
      <X>2</X>
      <Y>3</Y>
    </ApprovalSigningText>
  </Extras>
  <IsSignatureFromProfile>true</IsSignatureFromProfile>
  <Items>
    <ApprovalSigningInfo>
      <AttachmentID>1</AttachmentID>
      <Height>6</Height>
      <PageHeight>8</PageHeight>
      <PageNo>2</PageNo>
      <PageWidth>7</PageWidth>
      <Width>5</Width>
      <X>3</X>
      <Y>4</Y>
    </ApprovalSigningInfo>
    <ApprovalSigningInfo>
      <AttachmentID>1</AttachmentID>
      <Height>6</Height>
      <PageHeight>8</PageHeight>
      <PageNo>2</PageNo>
      <PageWidth>7</PageWidth>
      <Width>5</Width>
      <X>3</X>
      <Y>4</Y>
    </ApprovalSigningInfo>
  </Items>
  <Label>sample string 4</Label>
  <Password>sample string 9</Password>
  <ProcessActivityApprovalID>1</ProcessActivityApprovalID>
  <ProcessDetailID>3</ProcessDetailID>
  <ProcessID>2</ProcessID>
  <Signature>QEA=</Signature>
  <UseGroupDigitalSignature>true</UseGroupDigitalSignature>
  <UseUserDigitalSignature>true</UseUserDigitalSignature>
  <UserID>5</UserID>
</ApprovalSigningRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApprovalSigningRequest'.

Response Information

Resource Description

ResultResponse
NameDescriptionTypeAdditional information
StatusText

string

None.

Error

boolean

None.

Data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusText": "sample string 1",
  "Error": true,
  "Data": {}
}

application/xml, text/xml

Sample:
<ResultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">
  <Data />
  <Error>true</Error>
  <StatusText>sample string 1</StatusText>
</ResultResponse>