PUT api/Document/{docId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
docId

integer

Required

Body Parameters

DocumentPutRequest
NameDescriptionTypeAdditional information
fields

Collection of FieldValue

Required
pages

Collection of Page

Required
extension

string

Matching regular expression pattern: ^[a-zA-Z0-9]*$

Max length: 10

Request Formats

application/json, text/json

Sample: 
{
  "fields": [
    {
      "fieldId": 1,
      "value": "sample string 2"
    },
    {
      "fieldId": 1,
      "value": "sample string 2"
    }
  ],
  "pages": [
    {
      "pageData": "sample string 1"
    },
    {
      "pageData": "sample string 1"
    }
  ],
  "extension": "sample string 1"
}

application/xml, text/xml

Sample: 
<DocumentPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignAPI.Models.Requests">
  <extension>sample string 1</extension>
  <fields xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignAPI.Models.DTOs">
    <d2p1:FieldValue>
      <d2p1:fieldId>1</d2p1:fieldId>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:FieldValue>
    <d2p1:FieldValue>
      <d2p1:fieldId>1</d2p1:fieldId>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:FieldValue>
  </fields>
  <pages xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignAPI.Models.DTOs">
    <d2p1:Page>
      <d2p1:pageData>sample string 1</d2p1:pageData>
    </d2p1:Page>
    <d2p1:Page>
      <d2p1:pageData>sample string 1</d2p1:pageData>
    </d2p1:Page>
  </pages>
</DocumentPutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.