Esign (Facility Level)
E-Sign Information

Discussion

Create esign embed url for a given MoveInEvent in a given Facility. The MoveInEvent parameter must be the uuid associated with the MoveInEvent and the Facility parameter must be the uuid associated with the Facility. These parameters are passed in the request url and no parameters are passed into the body. The returning embed url uses DropboxSign to display and complete the esign documents. When certain events from DropboxSign trigger they will be transmitted via the window object

HTML Usage Example

The esign api gives back an embed url that can either be used outright, or embedded into an iframe or other front-end container. We capture DropboxSign events from the API and give these triggered events through a window message which can be captured through a window event listener. The type value corresponds to the enum value of the triggered event that DropboxSign sends to the DropboxSign client.

<div id="hellosign-container">
  <iframe id='hellosign-embed' src="{url from API}"></iframe>
</div>

<div class="signed">
  <p>Signed that iframe</p>
</div>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.0.0/jquery.min.js" integrity={your hash} crossorigin="anonymous"></script>
<script type="text/javascript">
$('.signed').hide();

window.addEventListener('message', e => {
  let a = e.data.type
  if(a==='sign')
  {
    $('#hellosign-container').hide();
    $('#hellosign-embed').remove();
    $('.signed').show();
  }
});

Examples

POST /v1/45cfb489-c8a4-46ce-9529-ed37b807192d/events/b6e08fc7-0c9f-4c50-b784-faa19901b7dd/esign
{
  "esign": {}
}
200
{
  "embed_url": "http://storedgefms.com/esign/6e863db5-085a-4431-bc1c-a57104ff26ec",
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "facility_id": "45cfb489-c8a4-46ce-9529-ed37b807192d",
      "event_id": "b6e08fc7-0c9f-4c50-b784-faa19901b7dd",
      "current_facility_id": "3730",
      "current_company_id": "8951",
      "esign": {}
    }
  }
}