digitaluapi

<back to all web services

CompaniesLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/companies
CompaniesLookup Parameters:
NameParameterData TypeRequiredDescription
NamequerystringNo
RegNoquerystringNo
CountriesIdqueryint?No
StatequerystringNo
CityquerystringNo
StreetAddressquerystringNo
ZipquerystringNo
TaxNoquerystringNo
SalesTaxPercentagequerydouble?No
EmailquerystringNo
WebsitequerystringNo
PhoneNumberquerystringNo
LogoUrlquerystringNo
CurrenciesIdqueryintNo
StatusCodesIdquerylongNo
Latquerydouble?No
Lngquerydouble?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /companies HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

[{"Name":"String","RegNo":"String","CountriesId":0,"State":"String","City":"String","StreetAddress":"String","Zip":"String","TaxNo":"String","SalesTaxPercentage":0,"Email":"String","Website":"String","PhoneNumber":"String","LogoUrl":"String","CurrenciesId":0,"StatusCodesId":0,"Lat":0,"Lng":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]