POST v1/Engage/searchCompany

Searches for a company from a given company name

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CompanyName		string	Required
LevenshteinDistanceThreshold		decimal number	Range: inclusive between 0 and 1

Request Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "LevenshteinDistanceThreshold": 2.1
}

application/xml, text/xml

Sample:

<InEngageSearchCompany xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Inbound">
  <CompanyName>sample string 1</CompanyName>
  <LevenshteinDistanceThreshold>2.1</LevenshteinDistanceThreshold>
</InEngageSearchCompany>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AdminEngageSearchCompanyResponse

Name	Type	Additional information
Companies	Collection of EngageSearchCompanyResult	None.
Message	string	None.
IsSuccessful	boolean	None.
ErrorCode	integer	None.
WarningMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Companies": [
    {
      "CompanyName": "sample string 1",
      "CompanyCode": "sample string 2",
      "LevenshteinDistance": 3.1
    },
    {
      "CompanyName": "sample string 1",
      "CompanyCode": "sample string 2",
      "LevenshteinDistance": 3.1
    }
  ],
  "Message": "sample string 1",
  "IsSuccessful": true,
  "ErrorCode": 3,
  "WarningMessage": "sample string 4"
}

application/xml, text/xml

Sample:

<AdminEngageSearchCompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
  <ErrorCode>3</ErrorCode>
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 1</Message>
  <WarningMessage>sample string 4</WarningMessage>
  <Companies>
    <EngageSearchCompanyResult>
      <CompanyCode>sample string 2</CompanyCode>
      <CompanyName>sample string 1</CompanyName>
      <LevenshteinDistance>3.1</LevenshteinDistance>
    </EngageSearchCompanyResult>
    <EngageSearchCompanyResult>
      <CompanyCode>sample string 2</CompanyCode>
      <CompanyName>sample string 1</CompanyName>
      <LevenshteinDistance>3.1</LevenshteinDistance>
    </EngageSearchCompanyResult>
  </Companies>
</AdminEngageSearchCompanyResponse>