Select-Synchronous

Overview

The Select-synchronous operation is used to select documents for immediate processing and retrieves the results of the Select request by displaying the PassthroughIdentifier, Status, StatusDescription, and SelectedDocuments.

Table 1. Method
Method	URL	Description
POST	/api/v1/Document/account/{accountId}/select-synchronous	The POST method submits the accountId as part of the Select call

Table 2. Request Parameters
Parameter	Type	Description
accountId	integer	required	The account used to associate to the request.
TransactionData	xml	Transaction data in the form of an XML file that will be used to process the request.	Transaction data in the form of a XML file that will be used to process the request.
ContentIdentifier	string	A string identifying the type of content to be used.	A string identifying the type of content to be used.
Callback	Callback	A sequence of elements indicating the Callback URL, Username and Password.	A sequence of elements indicating the Callback URL, Username and Password.
PassthroughIdentifier	string	The PassThroughIdentifier is an optional user-defined generated parameter. This parameter is case-sensitive. The PassThroughIdentifier MUST be unique for each request within a single Account and API call. If a PassThroughIdentifier has been submitted previously for an account and exists in the database, Expere Document Services will return the original transaction ID. A new transaction ID will not be created. If the PassThroughIdentifier is passed in the request and the parameter is empty (null), Expere Document Services will process the request and return a new transaction ID.	The PassthroughIdentifier is an optional user-defined generated parameter. This parameter is case-sensitive. The PassthroughIdentifier MUST be unique for each request within a single Account and API call. If a PassthroughIdentifier has been submitted previously for an account and exists in the database, Expere Document Services will return the original transaction ID. A new transaction ID will not be created. If the PassthroughIdentifier is passed in the request and the parameter is empty (null), Expere Document Services will process the request and return a new transaction ID.
EZTransform	EZTransform	Container object for EZTransform information.	Container object for EZTransform information.

Sample Request

{
  "select": {
    "request": {
      "transactionData": "PFR4biB4bWxucz0iaHR0cDovL3NjaGVt+",
      "contentIdentifier": "BaseLibrary.PKG.Default_Default",
      "callback": {
        "authorization": {
          "authType": "HTTPBasic",
          "user": "User1",
          "password": "xxxxxxxxxx",
          "token": "<Token>"
        },
        "url": "https:<sampleURL>"
      },
      "passthroughIdentifier": "123456789"
    }
  }
}

Note: the </transactionData> element must consist of base64 data.

Sample Response

<SelectSynchronousResponse xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2">
         <SelectSynchronousResult>
            <PassthroughIdentifier xsi:nil="true" xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data"/>
            <Status xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data">Sucessful</Status>
            <StatusDescription xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data"/>
            <SelectedDocuments xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data">
               <Documents>
                  <DocumentID>PKGD.LoanEstimate</DocumentID>
                  <Format xsi:nil="true"/>
                  <DisplayName>Loan Estimate</DisplayName>
                  <Type>Dynamic</Type>
                  <Autoselected>true</Autoselected>
                  <Suggested>false</Suggested>
                  <Copy>0</Copy>
                  <Order xsi:nil="true"/>
               </Documents>
            </SelectedDocuments>
         </SelectSynchronousResult>
      </SelectSynchronousResponse>