GET api/Esign/EsignLink?applicationId={applicationId}&sendToBroker={sendToBroker}&offPremises={offPremises}

Get a Esign Link which will allow you to embed the link in your own communications.

Request Information

Requires Authentication!

URI Parameters

NameDescriptionTypeAdditional information
applicationId

integer

Required

sendToBroker

boolean

Required

offPremises

boolean

Required

Body Parameters

None.

Response Information

Resource Description

Esign
NameDescriptionTypeAdditional information
ApplicationId

integer

None.

Links

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "ApplicationId": 1,
  "Links": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<Esign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advantage.Blink.Model">
  <ApplicationId>1</ApplicationId>
  <Links xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Links>
</Esign>