Production URL: https://websvcs.quikforms.com/ESign/MetaDataAPI/5300/ESignMetaData.asmx
WSDL: https://websvcs.quikforms.com/ESign/MetaDataAPI/5300/ESignMetaData.asmx?WSDL
Quik! hosts a web service method to retrieve a list of TransactionIDs for documents sent to e-sign vendors (DocuSign and SIGNiX) from Quik!. All transactions on this service will work for a CustomerID and all subsidiary CustomerIDs.
When a form is submitted to the e-sign vendor, Quik! will store meta data about that transaction for customers to retrieve. The following methods are used:
- GetESignTransactions
- UpdateESignTransactions
The customer can then call GetESignTransactions to get the transactions, call the e-sign vendor to get the transactions, match the results, and determine which transactions need further processing. When a record is done/processed, they can call UpdateESignTransactions to change the transaction's status, removing it from returned results in future calls to GetESignTransactions.
GetESignTransactions
Customers can call the GetESignTransactions method at Quik! to retrieve the list of transactions that are available to work on.
Request Parameters
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| StatusID | Integer | NO | The Status of the records to include: 1 Pending 2 Active 3 Inactive 4 Delete 5 In Process | |
| StartCreatedDate | Date | NO | The start date to include results based on the date the record was created | |
| EndCreatedDate | Date | NO | The end date to include results based on the date the record was created |
<?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:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/ESign/MetaDataAPI">
<CustomerID>string</CustomerID>
<Username>string</Username>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetESignTransactions xmlns="https://websvcs.quikforms.com/ESign/MetaDataAPI">
<StatusID>int</StatusID>
<StartCreatedDate>dateTime</StartCreatedDate>
<EndCreatedDate>dateTime</EndCreatedDate>
</GetESignTransactions>
</soap:Body>
</soap:Envelope>
Return Parameters
The meta data returned will include the following fields:
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| TransactionID | String | 36 | YES | The TransactionID value Quik! sent to e-sign vendor |
| DocumentSetId | String | YES | Document SetId from e-sign vendor | |
| DocSetDescription | String | YES | The DocSetDescription Quik! sent to e-sign vendor | |
| ClientID | String | YES | Customer ClientID | |
| AccountID | String | NO | Customer AccountID | |
| RepCode | String | 3 | YES | Customer RepCode |
| BDID | String | YES | Customer Broker Dealer identifier | |
| FormName | String | YES | Name or description of the form | |
| FormID | Integer | YES | Unique form ID within Quik! to differentiate one form from another. If the record is an attachment the FormID will be a zero. | |
| PageCount | Integer | YES | Number of pages for the FormID | |
| FormOrder | Integer | YES | Order of the documents in the package | |
| StatusID | Integer | YES | The status of the records to include (1 = Active, 2 = Inactive, 3 = Pending, 4 = Delete) | |
| CreateDate | Date | YES | The Date & Time the document ready for signing ceremony. | |
| FullFileName | String | YES | The expected file name of the PDF sent to the e-sign vendor. (NOTE: The PDF file name for forms is not stored in Quik!, only attachment file names are stored. Therefore, to return this value for forms, the file name is estimated and could possibly change between the time the PDF is sent to the e-sign vendor and when this service is called. To reliably match the file name between Quik! and the e-sign vendor, use the PartialFileName and match the right-most portion of the filename.) | |
| PartialFileName | String | YES | The right-most portion of the file name that will never change. Use this value for matching file names between Quik! and the e-sign vendor – match against the right-most portion of the e-sign vendor’s filename. | |
| AttachmentFlag | Boolean | YES | If TRUE then the record is an attachment and the FullFileName and PartialFileName fields will be identical and reliable for matching, and the FormID value will be 0. If FALSE then the record is a form with a valid FormID. |
<?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>
<GetESignTransactionsResponse xmlns="https://websvcs.quikforms.com/ESign/MetaDataAPI">
<GetESignTransactionsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</GetESignTransactionsResult>
</GetESignTransactionsResponse>
</soap:Body>
</soap:Envelope>
UpdateESignTransactions
Customers can call the UpdateESignTransactions method at Quik! to set the status of a transaction record so that future calls to the Get method returns only the desired records (e.g. only the active records).
Request Parameters
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| TransactionID | String | 36 | YES | The TransactionID who’s status will be set |
| StatusID | Integer | YES | The status of the records to include: 2 Active 3 Inactive 4 Delete |
<?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:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/ESign/MetaDataAPI">
<CustomerID>string</CustomerID>
<Username>string</Username>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<UpdateESignTransactions xmlns="https://websvcs.quikforms.com/ESign/MetaDataAPI">
<TransactionID>string</TransactionID>
<StatusID>int</StatusID>
</UpdateESignTransactions>
</soap:Body>
</soap:Envelope>
Return Parameters
This service will return no additional parameters beyond the standard results (error code, message, etc.).
<?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>
<UpdateESignTransactionsResponse xmlns="https://websvcs.quikforms.com/ESign/MetaDataAPI">
<UpdateESignTransactionsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</UpdateESignTransactionsResult>
</UpdateESignTransactionsResponse>
</soap:Body>
</soap:Envelope>