APIService
Click here for a complete list of operations.
RequestTemplateList
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api/3.0/api.asmx HTTP/1.1 Host: eu1.docusign.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.docusign.net/API/3.0/RequestTemplateList" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RequestTemplateList xmlns="http://www.docusign.net/API/3.0"> <TemplateIDs> <string>string</string> <string>string</string> </TemplateIDs> <IncludeDocumentBytes>boolean</IncludeDocumentBytes> </RequestTemplateList> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RequestTemplateListResponse xmlns="http://www.docusign.net/API/3.0"> <RequestTemplateListResult> <EnvelopeTemplate> <EnvelopeTemplateDefinition> <TemplateID>string</TemplateID> <Name>string</Name> <Shared>boolean</Shared> <TemplatePassword>string</TemplatePassword> <TemplateDescription>string</TemplateDescription> <LastModified>dateTime</LastModified> <PageCount>int</PageCount> </EnvelopeTemplateDefinition> <Envelope> <TransactionID>string</TransactionID> <Asynchronous>boolean</Asynchronous> <AccountId>string</AccountId> <Documents xsi:nil="true" /> <Recipients xsi:nil="true" /> <Tabs xsi:nil="true" /> <Subject>string</Subject> <EmailBlurb>string</EmailBlurb> <SigningLocation>InPerson or Online</SigningLocation> <CustomFields xsi:nil="true" /> <VaultingOptions xsi:nil="true" /> <AutoNavigation>boolean</AutoNavigation> <EnvelopeIdStamping>boolean</EnvelopeIdStamping> <AuthoritativeCopy>boolean</AuthoritativeCopy> <Notification xsi:nil="true" /> <EnvelopeAttachment xsi:nil="true" /> <EnforceSignerVisibility>boolean</EnforceSignerVisibility> <EnableWetSign>boolean</EnableWetSign> <AllowMarkup>boolean</AllowMarkup> <EventNotification xsi:nil="true" /> <AllowReassign>boolean</AllowReassign> <BrandId>string</BrandId> <BrandLock>boolean</BrandLock> <Accessibility>string</Accessibility> <MessageLock>boolean</MessageLock> <RecipientsLock>boolean</RecipientsLock> <UseDisclosure>boolean</UseDisclosure> <EmailSettings xsi:nil="true" /> <AuthoritativeCopyDefault>boolean</AuthoritativeCopyDefault> </Envelope> </EnvelopeTemplate> <EnvelopeTemplate> <EnvelopeTemplateDefinition> <TemplateID>string</TemplateID> <Name>string</Name> <Shared>boolean</Shared> <TemplatePassword>string</TemplatePassword> <TemplateDescription>string</TemplateDescription> <LastModified>dateTime</LastModified> <PageCount>int</PageCount> </EnvelopeTemplateDefinition> <Envelope> <TransactionID>string</TransactionID> <Asynchronous>boolean</Asynchronous> <AccountId>string</AccountId> <Documents xsi:nil="true" /> <Recipients xsi:nil="true" /> <Tabs xsi:nil="true" /> <Subject>string</Subject> <EmailBlurb>string</EmailBlurb> <SigningLocation>InPerson or Online</SigningLocation> <CustomFields xsi:nil="true" /> <VaultingOptions xsi:nil="true" /> <AutoNavigation>boolean</AutoNavigation> <EnvelopeIdStamping>boolean</EnvelopeIdStamping> <AuthoritativeCopy>boolean</AuthoritativeCopy> <Notification xsi:nil="true" /> <EnvelopeAttachment xsi:nil="true" /> <EnforceSignerVisibility>boolean</EnforceSignerVisibility> <EnableWetSign>boolean</EnableWetSign> <AllowMarkup>boolean</AllowMarkup> <EventNotification xsi:nil="true" /> <AllowReassign>boolean</AllowReassign> <BrandId>string</BrandId> <BrandLock>boolean</BrandLock> <Accessibility>string</Accessibility> <MessageLock>boolean</MessageLock> <RecipientsLock>boolean</RecipientsLock> <UseDisclosure>boolean</UseDisclosure> <EmailSettings xsi:nil="true" /> <AuthoritativeCopyDefault>boolean</AuthoritativeCopyDefault> </Envelope> </EnvelopeTemplate> </RequestTemplateListResult> </RequestTemplateListResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api/3.0/api.asmx HTTP/1.1 Host: eu1.docusign.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <RequestTemplateList xmlns="http://www.docusign.net/API/3.0"> <TemplateIDs> <string>string</string> <string>string</string> </TemplateIDs> <IncludeDocumentBytes>boolean</IncludeDocumentBytes> </RequestTemplateList> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <RequestTemplateListResponse xmlns="http://www.docusign.net/API/3.0"> <RequestTemplateListResult> <EnvelopeTemplate> <EnvelopeTemplateDefinition> <TemplateID>string</TemplateID> <Name>string</Name> <Shared>boolean</Shared> <TemplatePassword>string</TemplatePassword> <TemplateDescription>string</TemplateDescription> <LastModified>dateTime</LastModified> <PageCount>int</PageCount> </EnvelopeTemplateDefinition> <Envelope> <TransactionID>string</TransactionID> <Asynchronous>boolean</Asynchronous> <AccountId>string</AccountId> <Documents xsi:nil="true" /> <Recipients xsi:nil="true" /> <Tabs xsi:nil="true" /> <Subject>string</Subject> <EmailBlurb>string</EmailBlurb> <SigningLocation>InPerson or Online</SigningLocation> <CustomFields xsi:nil="true" /> <VaultingOptions xsi:nil="true" /> <AutoNavigation>boolean</AutoNavigation> <EnvelopeIdStamping>boolean</EnvelopeIdStamping> <AuthoritativeCopy>boolean</AuthoritativeCopy> <Notification xsi:nil="true" /> <EnvelopeAttachment xsi:nil="true" /> <EnforceSignerVisibility>boolean</EnforceSignerVisibility> <EnableWetSign>boolean</EnableWetSign> <AllowMarkup>boolean</AllowMarkup> <EventNotification xsi:nil="true" /> <AllowReassign>boolean</AllowReassign> <BrandId>string</BrandId> <BrandLock>boolean</BrandLock> <Accessibility>string</Accessibility> <MessageLock>boolean</MessageLock> <RecipientsLock>boolean</RecipientsLock> <UseDisclosure>boolean</UseDisclosure> <EmailSettings xsi:nil="true" /> <AuthoritativeCopyDefault>boolean</AuthoritativeCopyDefault> </Envelope> </EnvelopeTemplate> <EnvelopeTemplate> <EnvelopeTemplateDefinition> <TemplateID>string</TemplateID> <Name>string</Name> <Shared>boolean</Shared> <TemplatePassword>string</TemplatePassword> <TemplateDescription>string</TemplateDescription> <LastModified>dateTime</LastModified> <PageCount>int</PageCount> </EnvelopeTemplateDefinition> <Envelope> <TransactionID>string</TransactionID> <Asynchronous>boolean</Asynchronous> <AccountId>string</AccountId> <Documents xsi:nil="true" /> <Recipients xsi:nil="true" /> <Tabs xsi:nil="true" /> <Subject>string</Subject> <EmailBlurb>string</EmailBlurb> <SigningLocation>InPerson or Online</SigningLocation> <CustomFields xsi:nil="true" /> <VaultingOptions xsi:nil="true" /> <AutoNavigation>boolean</AutoNavigation> <EnvelopeIdStamping>boolean</EnvelopeIdStamping> <AuthoritativeCopy>boolean</AuthoritativeCopy> <Notification xsi:nil="true" /> <EnvelopeAttachment xsi:nil="true" /> <EnforceSignerVisibility>boolean</EnforceSignerVisibility> <EnableWetSign>boolean</EnableWetSign> <AllowMarkup>boolean</AllowMarkup> <EventNotification xsi:nil="true" /> <AllowReassign>boolean</AllowReassign> <BrandId>string</BrandId> <BrandLock>boolean</BrandLock> <Accessibility>string</Accessibility> <MessageLock>boolean</MessageLock> <RecipientsLock>boolean</RecipientsLock> <UseDisclosure>boolean</UseDisclosure> <EmailSettings xsi:nil="true" /> <AuthoritativeCopyDefault>boolean</AuthoritativeCopyDefault> </Envelope> </EnvelopeTemplate> </RequestTemplateListResult> </RequestTemplateListResponse> </soap12:Body> </soap12:Envelope>