POST api/CognitiveServices/GetCompanyBusinessSummary

Request Information

URI Parameters

None.

Body Parameters

CompanyBusinessSummaryRequest
NameDescriptionTypeAdditional information
ServiceType

string

None.

CompanyName

string

None.

CityStateOrCountry

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceType": "sample string 1",
  "CompanyName": "sample string 2",
  "CityStateOrCountry": "sample string 3"
}

application/xml, text/xml

Sample:
<CompanyBusinessSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infovores.Models">
  <CityStateOrCountry>sample string 3</CityStateOrCountry>
  <CompanyName>sample string 2</CompanyName>
  <ServiceType>sample string 1</ServiceType>
</CompanyBusinessSummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult
NameDescriptionTypeAdditional information
Response

boolean

None.

ReturnCode

integer

None.

Message

string

None.

Result

Object

None.

DemoState

string

None.

IsDemoMasked

boolean

None.

CreditsRemaining

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": true,
  "ReturnCode": 2,
  "Message": "sample string 3",
  "Result": {},
  "DemoState": "sample string 5",
  "IsDemoMasked": true,
  "CreditsRemaining": 1
}

application/xml, text/xml

Sample:
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infovores.Models">
  <CreditsRemaining>1</CreditsRemaining>
  <DemoState>sample string 5</DemoState>
  <IsDemoMasked>true</IsDemoMasked>
  <Message>sample string 3</Message>
  <Response>true</Response>
  <Result />
  <ReturnCode>2</ReturnCode>
</ApiResult>