The DocuSign SOAP API lists various limits on API fields, e.g. Username can be a maximum of 100 chars, Email can be a maximum of 100 chars. Does this mean that together, the "friendly name" and the email address can be 200 chars?
For Example, would this be okay (i.e. only an email):
ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong#gmail.com ?
And this would NOT be okay:
ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong [ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong#gmail.com] ?
And what happens if those (or other) string limits are exceeded? Is an error thrown or is it just truncated? If an error, what kind of error?
Using the Visual Studio debugger, I modified input fields, and checked the results of the fields in the Envelope which are the the most important to our application (which uses the SOAP API):
Document Name: This gets truncated to 100 characters by the DocuSign System. No error is generated.
Recipients -> UserName: if this is greater than 100 characters, the DocuSign SOAP API throws an "Unspecified Error"
Recipients -> Email: This would be truncated to 100 characters by the DocuSign System ... and therefore the above sample would become something like this "ThisIsAReallyLongUserNameWhichWillBeAbout58CharactersLong [ThisIsAReallyLongUserNameWhichWillBeAbou". No error was generated, but it would fail if used as an email address.
Email Subject: This gets truncated to 100 characters by the DocuSign System. No error is generated.
Related
I'm consuming the Outlook API, attempting to access all messages from an inbox which contains ~45,000 messages (and other folders such as Sent Items).
The main request I'm making is to https://outlook.office.com/api/v2.0/me/messages. If I add ?$count=true, the "#odata.count" value is returned as -1.
I can add $top=500 to the request which gives me 500 messages returned and an "#odata.nextLink", but if I pass $top=5000, there's no "#odata.nextLink" which I'd expect to see.
A few particular questions here if anyone can help:
Is this the best way to try and get all the messages out of all folders?
Is there a reason count would be returning -1, and is there a way to get an accurate figure of the number of messages returned?
Is there a maximum $top size I need to pass to get a valid request back?
Yes, but understand it includes Drafts, Deleted Items, and Sent Items in addition to all of the other mail folders.
This is a known issue with /me/messages. Basically the way that /me/messages gives all messages across all folders is by using a search folder, which dynamically updates. The API doesn't report accurate counts for search folders (usually just returns -1).
The highest $top should be 1000.
I have an email message that is 317 characters in my custom button code, and when I press the button to test the code, I receive this error:
Illegal Request
You have sent us an Illegal URL or an improperly formatted request.
When I reduce the number of characters in my email message, the button functions, no errors. I was looking in DocuSign documentation and it indicates that there is a character limit for the email message of 2000 characters. Why can't I use this email message with 317 characters? Anyone run into this?
I use 'Atom' feeds to read the content of gmail at the address
https://mail.google.com/mail/feed/atom/name where name is either empty (to check the inbox) or a user-defined label (even nested). To parse the result, it is useful to read the XML field fullcount, which gives the number of unread messages. With Gmail internal labels, like starred, important, sent, trash, drafts, spam, all, however, the fullcount is always 0. I recently discovered here that for the important label one should use the less intuitive name ^iim. With ^iim the fullcount is set correctly ! Does anyone know if there is a complete list of such labels available ?
They are called system labels and the Gmail Content Provider in Android documents a few:
ALL_MAIL ^all
DRAFTS ^r
INBOX ^i
INBOX_CATEGORY_FORUMS ^sq_ig_i_group
INBOX_CATEGORY_PRIMARY ^sq_ig_i_personal
INBOX_CATEGORY_PROMOTIONS ^sq_ig_i_promo
INBOX_CATEGORY_SOCIAL ^sq_ig_i_social
INBOX_CATEGORY_UPDATES ^sq_ig_i_notification
PRIORITY_INBOX ^iim
SENT ^f
SPAM ^s
STARRED ^t
TRASH ^k
There appears to be two ways I can gather status information about individual recipients on an envelope:
GET - v2/accounts/:accountId/envelopes/:envelopeId/recipients
GET - v2/accounts/:accountId/envelopes/:envelopeId/audit_events
Unfortunately, each of these suffers from a separate limitation that is making it difficult for me to use either.
This API call returns two DateTime values of interest: deliveredDateTime and signedDateTime. I am able to call and use this API successfully. However, it appears to me that deliveredDateTime is not specified until the user actually clicks the email link AND clicks the review documents button on the signer view. Since what I was actually interested in might be better described as sentDateTime, deliveredDateTime doesn't appear to work for my needs.
This API call returns a detailed list of all events that have transpired on the envelope, including individual receipient status updates. However, the data format is such that in order to tie the result data back to recipients, I have to do string matches on the recipient name. I'd prefer to do the match based on email or, better still, recipientID, but the audit log entries for "sent invitations" and "signed" don't contain these fields. Here is an example (click here to view larger):
Is there an API call other than these two that I can use? Is there a way to get additional data in the audit event API call?
Thank you in advance,
Andrew
I don't believe there's a way to get additional data from the audit_events call since the DocuSign API documentation (which is up to date) indicates that call has no parameters (other than the envelopeId in the URL).
I think you're stuck with doing a string comparison on the userName value to identify/link your recipients, however I want to point out that once you do that you can then link to their unique recipientGuid through the first api call you've highlighted here.
For instance, the /audit_events API call seems to achieve what you want and has all the info you need, however it identifies the recipients through their userNames. If you then make a call on the same envelope and check the response from the /recipients URI, it contains the name, email, recipientId, and recipientGuid for each and every recipient in the envelope. Match the user names and you now have access to their IDs, etc.
So in the end I don't believe there's one API call to achieve this but you can solve by doing one string compare and combining the results from the API calls you've highlighted.
Specifically, we get these errors: "Validation error: The 'http://www.docusign.net/API/3.0:UserName' element is invalid ... The actual length is greater than the MaxLength value." But I have not been able to find any documentation about what the maximum length of this field is. I'd like to warn users of this value so they don't have to do trial and error to get it to work. Specs on all the field limitations would be useful. Or if the error message message said something along the line of "...is greater than the MaxLength value of 50."
The XSD provides this type of information, but I'm not sure whether or not DocuSign makes the XSD available for public consumption. I'll leave it to #Ergin (DocuSign) to comment on that, and to provide the link to the XSD if appropriate. Regarding specifically the UserName field, Max Length seems to be 100.
The API Documentation has info on field limits. You go the DocuSign API Documentation page, open either the Online SOAP API guide or the SOAP PDF guide, and do a search for CreateAndSendEnvelope. See page 40 of the PDF guide for instance.
The guide lists the schema of the call, and if you read the descriptions they state the maximum limits. For instance, it states the email subject is maximum 100 characters, email blurb is maximum 2000 characters, etc.
For envelope recipients you'll see a link that leads you to the Recipients schema (see page 53 of the PDF). On there, you can see that UserName is maximum 100 characters.