ASP.NET Web API Help Page

GET nano/envelope-documents?envelopeId={envelopeId}&appId={appId}&loanProcessEventCategory={loanProcessEventCategory}

Retrieves all envelope documents associated with the envelope.

Request Information

URI Parameters

Name	Description	Type	Additional information
envelopeId	The envelope identifier.	integer	None.
appId	The app identifier.	integer	None.
loanProcessEventCategory	The loanProcessEventCategory.	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of envelope documents.

Collection of Nano.EnvelopeDocument

Name	Description	Type	Additional information
name	Gets or sets the name.	string	None.
order	Gets or sets the order.	integer	None.
id	Gets or sets the envelope document identifier.	integer	None.
envelope	Gets or sets the envelope identifier.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "name": "sample String 1",
    "order": 2,
    "id": "3",
    "envelope": "4"
  },
  {
    "name": "sample String 1",
    "order": 2,
    "id": "3",
    "envelope": "4"
  }
]

text/html

Sample:

[{"name":"sample String 1","order":2,"id":"3","envelope":"4"},{"name":"sample String 1","order":2,"id":"3","envelope":"4"}]

application/xml, text/xml

Sample:

<ArrayOfEnvelopeDocument xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EnvelopeDocument>
    <Name>sample String 1</Name>
    <Order>2</Order>
    <EnvelopeDocumentId>3</EnvelopeDocumentId>
    <EnvelopeId>4</EnvelopeId>
  </EnvelopeDocument>
  <EnvelopeDocument>
    <Name>sample String 1</Name>
    <Order>2</Order>
    <EnvelopeDocumentId>3</EnvelopeDocumentId>
    <EnvelopeId>4</EnvelopeId>
  </EnvelopeDocument>
</ArrayOfEnvelopeDocument>

application/vnd.api+json

Sample:

Sample not available.