I'm trying to access the "about me" field of a user's Connections 5 profile for a synchronization with our third party tool.
However, I don't seem to be able to find this field anywhere. I tried to access a user's (also my own) profile on /profiles/atom/profile.do?userid=5EEA50A0-0643-7A7D-C125-7D3800334349 but he returned feed does not include the desired information.
If i query profiles/atom/profileService.do I will get various link elements for my user profile none of which seem to include the "about me" field. However the result of this query includes a snx:editableFields section which contains a <snx:editableField name="description"> element which might refer to the desired "about me". Sadly, this field is empty for this request, although I know that my user has some information stored for "about me". All other fields in the snx:editableFields section do also not contain any data, so maybe this information is just structure description rather than really meant to hold the data?
Has anyone successfully tried to retrieve the "about me" or maybe "background" (snx:experience?) user properties via the API? Am I just missing the right call in the API documentation?
Thanks!
Try this URL
https://<your host>/profiles/atom/profileEntry.do?output=vcard&format=full&userid=<userid>
You will have two fields in the response
X_EXPERIENCE:<p dir="ltr">FOOBAR</p>
X_DESCRIPTION:<p dir="ltr">ABOUTLUCKY<br>
Related
We are developing feature that allows users to add identity verification to envelopes. And there's a checkbox which is called "Allow recipient to provide phone number"
We need to decide when to show that checkbox, because not all accounts have access to the checkbox.
From documentation (https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accounts/listsettings/) I see that there's phoneAuthRecipientMayProvidePhoneNumber field which allows to determine that thing.
When I open the page for envelope creation I can see that the checkbox is available but API returns false value for that field. So we can't really decide do we need to show that field or not.
It seems like a bug in API.
I took a look into this issue and I see that I'm getting the same behaviour - "phoneAuthRecipientMayProvidePhoneNumber" is always returning "false" for me as well, so I believe that you're correct that there's a product issue here. Can you email go-live#docusign.com with a link to this question and reference case number 07556985, which is a case created for this issue? Once you do that, I can create a ticket for this behaviour and let you know as it progresses.
I was a user of Right Signature, where we can create merge fields, and we can send the data through post request,
I have recently migrated to Docusign,
I see that they have prefil fields.
What I want to achieve is, Create Prefil fields, like Owner Name, Owner Email, etc,
And supply this fields through DOCUSIGN API, and send them. Is this functionality even possible.
I could not find any documentation, or perhaps I do not have the right search. Can some one point me to it, what will be the syntax for sending the templates, with prefil fields.
Thanks.
Anything you can do from the web app - you can do from API.
The term "pre-fill fields" means something very specific, but I'm not sure exactly what you want.
Any field in DocuSign can be "pre-filled" such that the value is set by the sender. The field can be read-only or can be edited by the person that it is assigned to.
You can also use pre-fill fields that are specific for the sender and therefore cannot be modified by anyone except the sender.
All of this is possible with the API, I suggest you first try it with the web app to understand. You can do everything for free with a developer account - try it and see if it serves your need.
At the end of the conversation I am creating a basic card which asks for a review. If the user does give a review I don't want to ask them again the next time. So what would be the best way to do so ? At the moment I am wondering whether I can track whether they have clicked on the button which leads to the review link provided in the BasicCard or not.
The link button does not report anything back to your fulfillment, so there is no direct way to know if the link has been clicked.
One possible workaround is a little convoluted, but would let you track if the link has been followed. It assumes, however, that you are storing a unique userid in the user storage (and that this is allowed in your jurisdiction). In this case what you can do is
When you generate the card, the link would go to another URL that you control - not the review URL directly.
The link would also include a parameter that includes the userid you've generated for them.
At the code running at this link, you get the userid parameter, mark in the database that they've been sent to the review page, then redirect them to the review page.
In future conversations, you can get the userid from their user storage and check your own records to see if they've been sent to the review page. From here, you can decide if you want to show the card, include the link, etc.
I am new to DocuSign, have made the tutorials and read through the DocuSign API documentation. I am developing in Java, and have successfully achieved to send documents for signing from a template to an email address. The document then gets opened, a custom field gets filled out. The document gets signed by the user.
Well now here are two questions that arise for me:
1) Am I right with the assumption that custom fields are to be used for virtually any form field like "Which pets do you have?" that a user is expected to fill out? Almost all the other fields which I can add when creating a template are being filled out automatically by DocuSign.
2) I have added a name and surname field as well as a custom field and the "sign here" field to the template from which I am sending the document via the API. Once the recipient has has filled out the information and signed the document, I would like to request the information which the user has entered into the custom field. How can I do that? I have found various requests for getting the status of a document or envelope. But never found how I can retrieve the actual user input.
Regards
Josef
In DocuSign if you have common tabs that you use for your recipients in your requests then you can use the Custom Fields to create them once then re-use them in your subsequent requests. However, in general if you want to have editable fields where you will gather info from your recipients then you can use the Text field and un-check read-only. If setting through the API it would look like this:
"textTabs": [
{
"tabLabel": "NameOfTheTab",
"value": "12345"
}
You can read more about using these fields through the Features section of the DocuSign Developer Center.
With regards to your second question of how to retrieve the data that your recipients fill out, remember that tabs are always specific to recipients (as opposed to the documents themselves) so take a look at the Get Tab Information for Recipient API call.
Example:
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
I want to make sure I am on the right track as I have been having some problems getting started with the API. I am looking to maintain a list of product application PDFs as templates on docusign. When a customer comes to our site and wants a particular product they need to fill out an application form. All the data would be collected on our site. I would then want to:
Create an envolope with the customer (and potentially other parties) that need to sign the document
Fill in the form fields from data collected on our site
Send the envelope out for signature and monitor the progress.
So in doing this I am trying to build this up a piece at a time and first task is to make sure that I can provide form data to docusign. I create a template with the docusign web user interface and all of the form fields seem to be preserved. However when I try and retrieve the template with API
https://demo.docusign.net/restapi/v2/accounts/xxxx/templates/yyyy
I see a very short response with an envelopeTemplateDefinition showing the correct name for the template but no documents object and no custom fields object. I have also tried this by creating an envelope with the document (in draft) but with similar results.
My apologies in advance for this newbie question.
I've repro'd the issue you describe -- i.e., the Response I get from a GET Template request contains only very limited information and is thereby not consistent with the expected Response as documented on pages 194-196 of the DocuSign REST API guide (http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf). Not sure if this is a bug with the GET Template operation or with the Documentation -- someone at DocuSign will need to confirm (#Ergin).
In light of this limitation with the GET Template operation, you can alternatively retrieve the recipient information (including tabs) and document information about a Template by using the GET Envelope Recipients and GET Envelope Documents operations -- just specify the TEMPLATE Id in place of the Envelope Id, as shown here:
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{templateId}/documents
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{templateId}/recipients?include_tabs=true