Add a New Document to an Existing Package

tatternutz | Posts: 24

Add a New Document to an Existing Package

Wednesday, March 8, 2017 at 04:05am

I am needing to add a new document to an existing package (http://docs.esignlive.com/content/c_integrator_s_guide/rest_api/documents.htm#Add) but I am not finding any JSON Request samples. I will be in my integration adding documents to an existing package one at time. I am creating a package then using that packageId in the POST /packages/{packageId}/documents. JSON Request Body (Create Package):

{
   "name": "nCino Package Test",
   "type":"PACKAGE",
   "language":"en",
   "emailMessage":"I just created a new Package",
   "description":"New Package",
   "autoComplete":true
}

I have also referenced this blog post (which was really good): https://www.esignlive.com/blog/e-signlive-for-new-users-how-to-create-and-send-your-first-package-rest-api/?_ga=1.239069376.1926485674.1488917201 But that blog post is not exactly my use and I tried gleaning what I could from it. Can I get a sample JSON payload along with all the available options?

March 8 Created

January 21 Last Updated

8 years ago Last Reply

5 Replies

234 Views

2 Users

0 Likes

0 Links

Answered by mwilliams

Approved Answer

mwilliams | Posts: 956

Reply to: Add a New Document to an Existing Package

Wednesday, March 8, 2017 at 09:43am

Sorry about that! Before you can add signatures that are tied to a person, you have to add that person to the package as a signer! :) Take a look at this guide: https://developer.esignlive.com/guides/feature-guides/signer-management/#rest-api Once you get your signer added, try again and let me know!

mwilliams | Posts: 956

Reply to: Add a New Document to an Existing Package

Wednesday, March 8, 2017 at 08:06am

Hey tatternutz, Take a look at this: https://developer.esignlive.com/guides/feature-guides/document-management/#rest-api And if you want to add signatures and fields at the same time of upload of the document, you can add them manually by including the JSON from this guide in the JSON {â€œapprovalsâ€:[{SignatureJSON}]} https://developer.esignlive.com/guides/feature-guides/signatures/#rest-api Which can better be seen in this guide which talks about other fields: https://developer.esignlive.com/guides/feature-guides/fields/#rest-api Finally, the best way to see a full package payload so you can see what the bits and pieces are of each would be to look at the full package JSON in this guide ( which is the same as the blog you referenced, essentially :) ): https://developer.esignlive.com/guides/quick-start/creating-and-sending-a-package-rest/#csharp You can also see a slightly dated schema, here: http://docs.e-signlive.com/10.0/schema/index.html

tatternutz | Posts: 24

Reply to: Add a New Document to an Existing Package

Wednesday, March 8, 2017 at 08:55am

Reference: https://developer.esignlive.com/guides/feature-guides/signatures/ I'm starting top down from your post (noob). I can create package and add document just fine. On to Signatures and this is what I'm getting for response - POST url: https://sandbox.esignlive.com/api/packages/8sZBIINEducdbChajGu4g-vgIPM=/documents/ce105de465c75bf598a3d4ba68080117b9d271a4ae139256/approvals Payload:

{
    "role": "Signer1",
    "id": "signature1",
    "fields": [{
        "top": 510,
        "left": 215,
        "width": 200,
        "height": 50,
        "page": 0,
        "type": "SIGNATURE",
        "subtype": "FULLNAME"
    }]
}

Response:

{
  "messageKey": "error.validation.validateApproval.noRolesOnApproval",
  "message": "No role specified as part of this approval.",
  "code": 400,
  "name": "Validation Error"
}

tatternutz | Posts: 24

Reply to: Add a New Document to an Existing Package

Wednesday, March 8, 2017 at 09:54am

Bingo Michael!!! I can now (in PostMan) -Create Package -Add Document -Add Signer -Set Approvals -Send out Package for signing. Thanks for the quick response. I'll Accept your last post as the answer. Now all I have to do is start building my integration :) Thank you, Rich

mwilliams | Posts: 956

Reply to: Add a New Document to an Existing Package

Wednesday, March 8, 2017 at 11:09am

Fantastic news! Let us know if you run into any other issues!