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
"use strict";
export class CompaniesLookup {
    /** @param {{Name?:string,RegNo?:string,CountriesId?:number,State?:string,City?:string,StreetAddress?:string,Zip?:string,TaxNo?:string,SalesTaxPercentage?:number,Email?:string,Website?:string,PhoneNumber?:string,LogoUrl?:string,CurrenciesId?:number,StatusCodesId?:number,Lat?:number,Lng?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    RegNo;
    /** @type {?number} */
    CountriesId;
    /** @type {string} */
    State;
    /** @type {string} */
    City;
    /** @type {string} */
    StreetAddress;
    /** @type {string} */
    Zip;
    /** @type {string} */
    TaxNo;
    /** @type {?number} */
    SalesTaxPercentage;
    /** @type {string} */
    Email;
    /** @type {string} */
    Website;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    LogoUrl;
    /** @type {number} */
    CurrenciesId;
    /** @type {number} */
    StatusCodesId;
    /** @type {?number} */
    Lat;
    /** @type {?number} */
    Lng;
}

JavaScript CompaniesLookup DTOs

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}]