Method ExtractServicing

ExtractServicing retrieves a loan in any currently-supported “SBA_ETran” XML version. The loan may be any you’re allowed to view. And, except for extra-important elements extracted first (“prime keys”, Loan element, etc), elements are generally extracted alphabetically for easy lookup.

What you do with the XML is up to you: Save it as an archive. Learn how to construct various versions of SBA XML. Determine the exact “canonical” spelling of XML elements. Modify it to call Servicing2. You could even use it to copy production loan applications (caweb.sba.gov) to the test environment (catweb2.sba.gov) for in-house training with realistic data.

SOAP Component:	https://catweb.sba.gov/elend/ws/elend.wsdl.
SOAP Method:	SharedEntryPoint, only input is structure Inputs
Or:	SharedEntryString, only input is JSON string InputString that decodes to a structure
REST Component:	/rest/elend/flexible
REST Method:	/rest/elend/flexible/SharedEntryPoint, only input is structure Inputs
Or:	/rest/elend/flexible/SharedEntryString, only input is JSON string InputString
Keys of the Input Structure:
MethodNamePhysical	Mandatory. Must be “ExtractServicing”.
CLSUsername	Mandatory. CLS login’s username with at least read permission in Servicing.
CLSPassword	Mandatory. CLS login’s password with at least read permission in Servicing.
CLSPIN	Mandatory. PIN generated by Generate_PIN using the same login.
ApplicationNumber	Mandatory. SBA Application Number of app to be extracted.
SoftwareVendorCode	Mandatory. A private code that authorizes use of SoftwareVendorName.
SoftwareVendorName	Mandatory. Value from Code Tables, Vendor Table.
EMail	Optional. Email address of person making the call.
ExtractAppList	Optional. Allows extracting multiple apps in one XML file. (See below.)
ExtractLoanList	Optional. Allows extracting multiple loans in one XML file. (See below.)
ExtractOptions	Optional. Comma-delimited list of option codes. (See below.)
ExtractReason	Optional. Add a reason attribute to the root tag with this information. Convenience note.
ExtractVersion	Optional. SBA_ETran version number. If absent, the current default version will be used.
FormatOut	Optional. Format of ResponseData. XML or JSON. See Format IN/OUT Defaults
Keys of the Output Structure:
ErrorMessageEnglish	Should be nullstring. If not, a generally-worded error message.
ErrorMessageTechnical	Should be nullstring. If not, a more helpful error message, but scarier to some users.
PasswordUpdateRequired	“Yes”, “No”, number of days till expiration or “TBD” (prior to validating login).
ResponseData	The extracted XML in SBA_ETran.orig.xsd format (for the version requested).

For examples of calling flexible, structured methods, see Flexible Structure of Inputs For an explanation of REST calls, see Calling Rest Methods

If ApplicationNumber is given, it overrides ExtractAppList and ExtractLoanList. If ApplicationNumber is not given, and ExtractAppList is given, it must contain a comma-delimited list of SBA application numbers, and it overrides ExtractLoanList. If neither ApplicationNumber nor ExtractAppList is given, ExtractLoanList becomes mandatory and must contain a comma-delimited list of SBA loan numbers (10-digit format preferred). In all cases, the CLS login account must have read access to the requested loan(s). When a list is specified, all loans will be contained in a single file, as allowed by SBA_ETran format.

Currently available ExtractOptions are:

• “cmp” – compresses out whitespace between tags. The default is indented, which is more human-readable.
• "env” – adds an attribute to the root tag to indicate environment (such as “test” or “prod”).
• “lqd” – extracts LiquidCredit information in LoanApplication, Borrower and Principal elements.
• “oda” – extracts SBA Office of Disaster Assistance information. Only useful with disaster loans.

Example combination: If ExtractOptions is “env”, ExtractReason is “for electronic portfolio” and ExtractVersion is “5.0”, calling ExtractServicing on caweb.sba.gov (production environment) is liable to extract XML with the following root element:

<SBA_ETran version="5.0" environment="prod" reason="for electronic portfolio">