Method SearchProposal

SearchProposal(String, SearchDefinitionContract, String, String, Int32)

Search proposal for objects

Declaration

List<string> SearchProposal(string connectionId, SearchDefinitionContract searchDefinition, string propertyTypeId, string inputValue, int maxCount)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
SearchDefinitionContract	searchDefinition	Optional: Definition of search conditions
System.String	propertyTypeId	Search proposal for the property type id. See also Id
System.String	inputValue	Optional: value contained in proposal
System.Int32	maxCount	Number of results to return

Returns

Type	Description
System.Collections.Generic.List<System.String>	Returns the result of search proposal

Examples

POST http://YourServerName/InfoShare/Json/Search/SearchProposal

A simple example for search proposal.

{
   "connectionId": "29edddd1-f659-4aa7-8248-54bae7121038",
   "searchDefinition": {
     "Conditions": [{
       "Values": ["2019-09-26T12:06:48"],
       "ComparisonEnum": "LessEquals",
       "PlaceHolder": "",
       "PropertyTypeId": "01000009-38a7-11d8-a902-0050bf427e8f",
       "RelationEnum": "And" }],
    "FulltextWordRelation": "AND",
    "FulltextWords": "",
    "PageSize": 100,
    "SearchStores": ["4b07ac1e-b9cf-e911-a939-00155d290a08", "c5b7dd4e-b8cf-e911-a939-00155d290a08",
    "5ff3c8f6-b8cf-e911-a939-00155d290a08", "3bb6448c-b9cf-e911-a939-00155d290a08",
    "67727470-b9cf-e911-a939-00155d290a08", "e46bc061-b7cf-e911-a939-00155d290a08"],
    "UseWildCard": true },
  "propertyTypeId": "760fa49a-c1cf-e911-a939-00155d290a08",
  "inputValue": "",
  "maxCount": 20
}

Response:

{
   "SearchProposalResult":["Lizenzenrechnung","Pauschalrechnung","Telefonrechnung"]
}

Example for search proposal with optional paramater.

{
   "connectionId": "29edddd1-f659-4aa7-8248-54bae7121038",
   "searchDefinition": {
     "Conditions": [{
       "Values": ["2019-09-26T12:06:48"],
       "ComparisonEnum": "LessEquals",
       "PlaceHolder": "",
       "PropertyTypeId": "01000009-38a7-11d8-a902-0050bf427e8f",
       "RelationEnum": "And" }],
    "FulltextWordRelation": "AND",
    "FulltextWords": "",
    "PageSize": 100,
    "SearchStores": ["4b07ac1e-b9cf-e911-a939-00155d290a08", "c5b7dd4e-b8cf-e911-a939-00155d290a08",
    "5ff3c8f6-b8cf-e911-a939-00155d290a08", "3bb6448c-b9cf-e911-a939-00155d290a08",
    "67727470-b9cf-e911-a939-00155d290a08", "e46bc061-b7cf-e911-a939-00155d290a08"],
    "UseWildCard": true },
  "propertyTypeId": "760fa49a-c1cf-e911-a939-00155d290a08",
  "inputValue": "Liz",
  "maxCount": 20
}

Response:

{
   "SearchProposalResult":["Lizenzenrechnung"]
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Search store not found {infoStore} (10033)
ServiceException	Property type not found {propertyTypeId} (10034)
ServiceException	String was not recognized as a valid DateTime: {dateTimeValue}. Expected format {expectedFormat} (10059)
ServiceException	Comparison operator {comparisonOperator} is not allowed for property type {propertyTypeId} (10087)
ServiceException	Unknown comparison operator {comparisonOperator} (10088)
ServiceException	Property type {propertyTypeId} is deleted (10090)
ServiceException	Property type {propertyTypeId} is deactivated (10091)
ServiceException	Guid property type is not supported (10141)
ServiceException	Verification code is needed: Verification code not yet verified (10152)