Skip to navigation

RequestStatuses

View as Markdown

API user specific rules

  • The EnvelopeID, UserName and Email specified in the RequestStatus, EnvelopeStatus RecipientStatus, and RequestStatuses methods shall not exceed 100 characters.
  • AccountID specified in RequestStatuses should not exceed 100 characters.

Rules for Exceptions thrown by the API

  • An envelope having the specified EnvelopeID must exist in the system. Else, an exception with the error message “Envelope_Does_Not_Exist” is thrown.
  • In RequestStatus method User defined by UserName and Email pair should have the permission to request for envelope status. Only sender recipient or a user in the same account as sender with account wide permission will be able to request for the status. Else an exception is thrown with error message “User_Lacks_Permissions”.
  • In the RequestStatuses method, user defined by UserName and Email pair should belong to the account specified by AccountID. Else an exception with error message “User_Does_Not_Belong_To_Specified_Account” thrown.
  • In the RequestStatuses method the envelopes for which the status is requested should owned by account in the specified AccountID. Else an exception is thrown with error message “Account_Not_Authorized_For_Envelope”.