POST api/SaveEsignAgreement/{ClientId}/{value}/{StaffId}

Request Information

URI Parameters

Name	Type	Additional information
ClientId	string	Required
StaffId	string	Required
value	string	None.

Body Parameters

BOEsignAgreement

Name	Type	Additional information
file	File1	None.
invitees	Collection of Invitee	None.
irn	string	None.
folderId	string	None.
expiryDays	integer	None.
requestSignOrder	boolean	None.
deleteOnComplete	boolean	None.
message	string	None.
stampSeries	string	None.
seriesGroup	string	None.
stampValue	string	None.
attachments	Collection of Attachment	None.

Request Formats

application/json, text/json

Sample:

{
  "file": {
    "name": "sample string 1",
    "file": "sample string 2",
    "templateId": "sample string 3",
    "fields": [
      {
        "id": "sample string 1",
        "required": true,
        "type": "sample string 3",
        "value": "sample string 4"
      },
      {
        "id": "sample string 1",
        "required": true,
        "type": "sample string 3",
        "value": "sample string 4"
      }
    ],
    "allowFill": true
  },
  "invitees": [
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "phone": "sample string 3",
      "emailNotification": true,
      "phoneNotification": true,
      "appearances": [
        {
          "x1": 1,
          "y1": 2,
          "x2": 3,
          "y2": 4,
          "page": "sample string 5"
        },
        {
          "x1": 1,
          "y1": 2,
          "x2": 3,
          "y2": 4,
          "page": "sample string 5"
        }
      ],
      "fixedName": true,
      "noName": true,
      "supportingDocuments": [
        {
          "name": "sample string 1"
        },
        {
          "name": "sample string 1"
        }
      ],
      "orgConfig": {
        "require": true,
        "name": "sample string 2",
        "sealType": "sample string 3"
      },
      "enforceAuthentication": true,
      "captureLocation": true,
      "capturePhoto": true,
      "webhook": {
        "success": "sample string 1",
        "failure": "sample string 2",
        "version": 3.1
      },
      "baseUrl": "sample string 11",
      "redirectUrl": "sample string 12",
      "retry": 13,
      "customConsent": "sample string 14",
      "signatures": [
        {
          "type": "sample string 1",
          "config": {
            "authTypes": [
              "sample string 1",
              "sample string 2"
            ],
            "verifyName": true,
            "verifyPincode": "sample string 2",
            "verifyState": "sample string 3",
            "verifyYob": 4,
            "verifyGender": "sample string 5",
            "verifyTitle": "sample string 6",
            "id": "sample string 7",
            "passkey": "sample string 8"
          }
        },
        {
          "type": "sample string 1",
          "config": {
            "authTypes": [
              "sample string 1",
              "sample string 2"
            ],
            "verifyName": true,
            "verifyPincode": "sample string 2",
            "verifyState": "sample string 3",
            "verifyYob": 4,
            "verifyGender": "sample string 5",
            "verifyTitle": "sample string 6",
            "id": "sample string 7",
            "passkey": "sample string 8"
          }
        }
      ]
    },
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "phone": "sample string 3",
      "emailNotification": true,
      "phoneNotification": true,
      "appearances": [
        {
          "x1": 1,
          "y1": 2,
          "x2": 3,
          "y2": 4,
          "page": "sample string 5"
        },
        {
          "x1": 1,
          "y1": 2,
          "x2": 3,
          "y2": 4,
          "page": "sample string 5"
        }
      ],
      "fixedName": true,
      "noName": true,
      "supportingDocuments": [
        {
          "name": "sample string 1"
        },
        {
          "name": "sample string 1"
        }
      ],
      "orgConfig": {
        "require": true,
        "name": "sample string 2",
        "sealType": "sample string 3"
      },
      "enforceAuthentication": true,
      "captureLocation": true,
      "capturePhoto": true,
      "webhook": {
        "success": "sample string 1",
        "failure": "sample string 2",
        "version": 3.1
      },
      "baseUrl": "sample string 11",
      "redirectUrl": "sample string 12",
      "retry": 13,
      "customConsent": "sample string 14",
      "signatures": [
        {
          "type": "sample string 1",
          "config": {
            "authTypes": [
              "sample string 1",
              "sample string 2"
            ],
            "verifyName": true,
            "verifyPincode": "sample string 2",
            "verifyState": "sample string 3",
            "verifyYob": 4,
            "verifyGender": "sample string 5",
            "verifyTitle": "sample string 6",
            "id": "sample string 7",
            "passkey": "sample string 8"
          }
        },
        {
          "type": "sample string 1",
          "config": {
            "authTypes": [
              "sample string 1",
              "sample string 2"
            ],
            "verifyName": true,
            "verifyPincode": "sample string 2",
            "verifyState": "sample string 3",
            "verifyYob": 4,
            "verifyGender": "sample string 5",
            "verifyTitle": "sample string 6",
            "id": "sample string 7",
            "passkey": "sample string 8"
          }
        }
      ]
    }
  ],
  "irn": "sample string 1",
  "folderId": "sample string 2",
  "expiryDays": 3,
  "requestSignOrder": true,
  "deleteOnComplete": true,
  "message": "sample string 6",
  "stampSeries": "sample string 7",
  "seriesGroup": "sample string 8",
  "stampValue": "sample string 9",
  "attachments": [
    {
      "file": "sample string 1",
      "name": "sample string 2",
      "type": "sample string 3",
      "contentType": "sample string 4"
    },
    {
      "file": "sample string 1",
      "name": "sample string 2",
      "type": "sample string 3",
      "contentType": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<BOEsignAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects">
  <attachments>
    <Attachment>
      <contentType>sample string 4</contentType>
      <file>sample string 1</file>
      <name>sample string 2</name>
      <type>sample string 3</type>
    </Attachment>
    <Attachment>
      <contentType>sample string 4</contentType>
      <file>sample string 1</file>
      <name>sample string 2</name>
      <type>sample string 3</type>
    </Attachment>
  </attachments>
  <deleteOnComplete>true</deleteOnComplete>
  <expiryDays>3</expiryDays>
  <file>
    <allowFill>true</allowFill>
    <fields>
      <FieldsObject>
        <id>sample string 1</id>
        <required>true</required>
        <type>sample string 3</type>
        <value>sample string 4</value>
      </FieldsObject>
      <FieldsObject>
        <id>sample string 1</id>
        <required>true</required>
        <type>sample string 3</type>
        <value>sample string 4</value>
      </FieldsObject>
    </fields>
    <file>sample string 2</file>
    <name>sample string 1</name>
    <templateId>sample string 3</templateId>
  </file>
  <folderId>sample string 2</folderId>
  <invitees>
    <Invitee>
      <appearances>
        <Appearance>
          <page>sample string 5</page>
          <x1>1</x1>
          <x2>3</x2>
          <y1>2</y1>
          <y2>4</y2>
        </Appearance>
        <Appearance>
          <page>sample string 5</page>
          <x1>1</x1>
          <x2>3</x2>
          <y1>2</y1>
          <y2>4</y2>
        </Appearance>
      </appearances>
      <baseUrl>sample string 11</baseUrl>
      <captureLocation>true</captureLocation>
      <capturePhoto>true</capturePhoto>
      <customConsent>sample string 14</customConsent>
      <email>sample string 2</email>
      <emailNotification>true</emailNotification>
      <enforceAuthentication>true</enforceAuthentication>
      <fixedName>true</fixedName>
      <name>sample string 1</name>
      <noName>true</noName>
      <orgConfig>
        <name>sample string 2</name>
        <require>true</require>
        <sealType>sample string 3</sealType>
      </orgConfig>
      <phone>sample string 3</phone>
      <phoneNotification>true</phoneNotification>
      <redirectUrl>sample string 12</redirectUrl>
      <retry>13</retry>
      <signatures>
        <Signature>
          <config>
            <authTypes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </authTypes>
            <id>sample string 7</id>
            <passkey>sample string 8</passkey>
            <verifyGender>sample string 5</verifyGender>
            <verifyName>true</verifyName>
            <verifyPincode>sample string 2</verifyPincode>
            <verifyState>sample string 3</verifyState>
            <verifyTitle>sample string 6</verifyTitle>
            <verifyYob>4</verifyYob>
          </config>
          <type>sample string 1</type>
        </Signature>
        <Signature>
          <config>
            <authTypes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </authTypes>
            <id>sample string 7</id>
            <passkey>sample string 8</passkey>
            <verifyGender>sample string 5</verifyGender>
            <verifyName>true</verifyName>
            <verifyPincode>sample string 2</verifyPincode>
            <verifyState>sample string 3</verifyState>
            <verifyTitle>sample string 6</verifyTitle>
            <verifyYob>4</verifyYob>
          </config>
          <type>sample string 1</type>
        </Signature>
      </signatures>
      <supportingDocuments>
        <SupportingDocument>
          <name>sample string 1</name>
        </SupportingDocument>
        <SupportingDocument>
          <name>sample string 1</name>
        </SupportingDocument>
      </supportingDocuments>
      <webhook>
        <failure>sample string 2</failure>
        <success>sample string 1</success>
        <version>3.1</version>
      </webhook>
    </Invitee>
    <Invitee>
      <appearances>
        <Appearance>
          <page>sample string 5</page>
          <x1>1</x1>
          <x2>3</x2>
          <y1>2</y1>
          <y2>4</y2>
        </Appearance>
        <Appearance>
          <page>sample string 5</page>
          <x1>1</x1>
          <x2>3</x2>
          <y1>2</y1>
          <y2>4</y2>
        </Appearance>
      </appearances>
      <baseUrl>sample string 11</baseUrl>
      <captureLocation>true</captureLocation>
      <capturePhoto>true</capturePhoto>
      <customConsent>sample string 14</customConsent>
      <email>sample string 2</email>
      <emailNotification>true</emailNotification>
      <enforceAuthentication>true</enforceAuthentication>
      <fixedName>true</fixedName>
      <name>sample string 1</name>
      <noName>true</noName>
      <orgConfig>
        <name>sample string 2</name>
        <require>true</require>
        <sealType>sample string 3</sealType>
      </orgConfig>
      <phone>sample string 3</phone>
      <phoneNotification>true</phoneNotification>
      <redirectUrl>sample string 12</redirectUrl>
      <retry>13</retry>
      <signatures>
        <Signature>
          <config>
            <authTypes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </authTypes>
            <id>sample string 7</id>
            <passkey>sample string 8</passkey>
            <verifyGender>sample string 5</verifyGender>
            <verifyName>true</verifyName>
            <verifyPincode>sample string 2</verifyPincode>
            <verifyState>sample string 3</verifyState>
            <verifyTitle>sample string 6</verifyTitle>
            <verifyYob>4</verifyYob>
          </config>
          <type>sample string 1</type>
        </Signature>
        <Signature>
          <config>
            <authTypes xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </authTypes>
            <id>sample string 7</id>
            <passkey>sample string 8</passkey>
            <verifyGender>sample string 5</verifyGender>
            <verifyName>true</verifyName>
            <verifyPincode>sample string 2</verifyPincode>
            <verifyState>sample string 3</verifyState>
            <verifyTitle>sample string 6</verifyTitle>
            <verifyYob>4</verifyYob>
          </config>
          <type>sample string 1</type>
        </Signature>
      </signatures>
      <supportingDocuments>
        <SupportingDocument>
          <name>sample string 1</name>
        </SupportingDocument>
        <SupportingDocument>
          <name>sample string 1</name>
        </SupportingDocument>
      </supportingDocuments>
      <webhook>
        <failure>sample string 2</failure>
        <success>sample string 1</success>
        <version>3.1</version>
      </webhook>
    </Invitee>
  </invitees>
  <irn>sample string 1</irn>
  <message>sample string 6</message>
  <requestSignOrder>true</requestSignOrder>
  <seriesGroup>sample string 8</seriesGroup>
  <stampSeries>sample string 7</stampSeries>
  <stampValue>sample string 9</stampValue>
</BOEsignAgreement>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BOEsignAgreementResponse

Name	Type	Additional information
status	integer	None.
messages	Collection of Message	None.
data	Data	None.
TemplateId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "messages": [
    {
      "code": "sample string 1",
      "message": "sample string 2"
    },
    {
      "code": "sample string 1",
      "message": "sample string 2"
    }
  ],
  "data": {
    "documentId": "sample string 1",
    "irn": "sample string 2",
    "invitations": [
      {
        "name": "sample string 1",
        "email": "sample string 2",
        "phone": "sample string 3",
        "signUrl": "sample string 4",
        "active": true,
        "expiryDate": "sample string 6"
      },
      {
        "name": "sample string 1",
        "email": "sample string 2",
        "phone": "sample string 3",
        "signUrl": "sample string 4",
        "active": true,
        "expiryDate": "sample string 6"
      }
    ]
  },
  "TemplateId": "sample string 2"
}

application/xml, text/xml

Sample:

<BOEsignAgreementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects">
  <TemplateId>sample string 2</TemplateId>
  <data>
    <documentId>sample string 1</documentId>
    <invitations>
      <Invitation>
        <active>true</active>
        <email>sample string 2</email>
        <expiryDate>sample string 6</expiryDate>
        <name>sample string 1</name>
        <phone>sample string 3</phone>
        <signUrl>sample string 4</signUrl>
      </Invitation>
      <Invitation>
        <active>true</active>
        <email>sample string 2</email>
        <expiryDate>sample string 6</expiryDate>
        <name>sample string 1</name>
        <phone>sample string 3</phone>
        <signUrl>sample string 4</signUrl>
      </Invitation>
    </invitations>
    <irn>sample string 2</irn>
  </data>
  <messages>
    <Message>
      <code>sample string 1</code>
      <message>sample string 2</message>
    </Message>
    <Message>
      <code>sample string 1</code>
      <message>sample string 2</message>
    </Message>
  </messages>
  <status>1</status>
</BOEsignAgreementResponse>