POST api/transaction

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InstanceId	integer	None.
DiaryId	string	None.
AttachmentId	string	None.
Documents	Collection of Document	None.
Recipients	Collection of Signer	None.

Request Formats

application/json, text/json

Sample:

{
  "InstanceId": 1,
  "DiaryId": "sample string 2",
  "AttachmentId": "sample string 3",
  "Documents": [
    {
      "DocumentId": "sample string 1",
      "Name": "sample string 2",
      "FileExtension": "sample string 3",
      "DocumentBase64": "sample string 4"
    },
    {
      "DocumentId": "sample string 1",
      "Name": "sample string 2",
      "FileExtension": "sample string 3",
      "DocumentBase64": "sample string 4"
    }
  ],
  "Recipients": [
    {
      "RecipientId": "sample string 1",
      "RoutingOrder": "sample string 2",
      "Name": "sample string 3",
      "Email": "sample string 4",
      "ClientUserId": "sample string 5",
      "Tabs": {
        "SignHereTabs": [
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5",
            "ScaleValue": 6.1
          },
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5",
            "ScaleValue": 6.1
          }
        ],
        "DateSignedTabs": [
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5"
          },
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5"
          }
        ]
      }
    },
    {
      "RecipientId": "sample string 1",
      "RoutingOrder": "sample string 2",
      "Name": "sample string 3",
      "Email": "sample string 4",
      "ClientUserId": "sample string 5",
      "Tabs": {
        "SignHereTabs": [
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5",
            "ScaleValue": 6.1
          },
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5",
            "ScaleValue": 6.1
          }
        ],
        "DateSignedTabs": [
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5"
          },
          {
            "RecipientId": "sample string 1",
            "AnchorString": "sample string 2",
            "AnchorUnits": "sample string 3",
            "AnchorXOffset": "sample string 4",
            "AnchorYOffset": "sample string 5"
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<EvoDocuSignPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Service.Models">
  <AttachmentId>sample string 3</AttachmentId>
  <DiaryId>sample string 2</DiaryId>
  <Documents>
    <Document>
      <DocumentBase64>sample string 4</DocumentBase64>
      <DocumentId>sample string 1</DocumentId>
      <FileExtension>sample string 3</FileExtension>
      <Name>sample string 2</Name>
    </Document>
    <Document>
      <DocumentBase64>sample string 4</DocumentBase64>
      <DocumentId>sample string 1</DocumentId>
      <FileExtension>sample string 3</FileExtension>
      <Name>sample string 2</Name>
    </Document>
  </Documents>
  <InstanceId>1</InstanceId>
  <Recipients>
    <Signer>
      <ClientUserId>sample string 5</ClientUserId>
      <Email>sample string 4</Email>
      <Name>sample string 3</Name>
      <RecipientId>sample string 1</RecipientId>
      <RoutingOrder>sample string 2</RoutingOrder>
      <Tabs>
        <DateSignedTabs>
          <DateSignedTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
          </DateSignedTab>
          <DateSignedTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
          </DateSignedTab>
        </DateSignedTabs>
        <SignHereTabs>
          <SignHereTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
            <ScaleValue>6.1</ScaleValue>
          </SignHereTab>
          <SignHereTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
            <ScaleValue>6.1</ScaleValue>
          </SignHereTab>
        </SignHereTabs>
      </Tabs>
    </Signer>
    <Signer>
      <ClientUserId>sample string 5</ClientUserId>
      <Email>sample string 4</Email>
      <Name>sample string 3</Name>
      <RecipientId>sample string 1</RecipientId>
      <RoutingOrder>sample string 2</RoutingOrder>
      <Tabs>
        <DateSignedTabs>
          <DateSignedTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
          </DateSignedTab>
          <DateSignedTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
          </DateSignedTab>
        </DateSignedTabs>
        <SignHereTabs>
          <SignHereTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
            <ScaleValue>6.1</ScaleValue>
          </SignHereTab>
          <SignHereTab>
            <AnchorString>sample string 2</AnchorString>
            <AnchorUnits>sample string 3</AnchorUnits>
            <AnchorXOffset>sample string 4</AnchorXOffset>
            <AnchorYOffset>sample string 5</AnchorYOffset>
            <RecipientId>sample string 1</RecipientId>
            <ScaleValue>6.1</ScaleValue>
          </SignHereTab>
        </SignHereTabs>
      </Tabs>
    </Signer>
  </Recipients>
</EvoDocuSignPackage>

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 'EvoDocuSignPackage'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.