Method Search

The Search method is used to retrieve information about a given, valid SBA Location ID. The information retrieved can be either agreements information or general information about the partner’s location, according to Inputs.SearchAgreements.

API Documentation
SOAP Component: https://catweb.sba.gov/pims/ws/pims2.wsdl.
SOAP Method: Search, only input is structure Inputs. (No JSON-string equivalent method.)
REST Component: /rest/pims/legacy/
REST Method: /rest/pims/legacy/Search
Keys of the Input Structure:
  • CLSUsername
    		•  Mandatory. CLS login’s username with read permissions in PIMS.
  • CLSPassword
    		•  Mandatory. CLS login’s password with read permissions in PIMS.
  • CLSPIN
    		•  Mandatory. PIN generated by Generate_PIN using the same login.
  • SearchAgreements
    		•  Mandatory. Must be “Yes” to retrieve agreements or “No” retrieve location information.
  • LocationId
    		•  Mandatory. The SBA’s Location ID (identifier of a partner’s location).
    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).
  • Comment
    		•  If successful “Password changed.”
  • ResultCode
    		•  0 for success, some other value for failure. (The number returned is significant.)

    For examples of calling flexible, structured methods, see Flexible Structure of Inputs

    Response, when deserialized from JSON string format:

    Partners (structure)
    Agreements (container of a table)
    Columns
    1-dimensional array of table header names
    Data
    2-dimensional array of table data
    Contacts (container of a table)
    Columns
    1-dimensional array of table header names
    Data
    2-dimensional array of table data