digitaluapi

CompaniesLookup

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/companies


// @DataContract
export class CompaniesLookup
{
    // @DataMember(Order=2)
    public Name: string;

    // @DataMember(Order=3)
    public RegNo: string;

    // @DataMember(Order=4)
    public CountriesId?: number;

    // @DataMember(Order=5)
    public State: string;

    // @DataMember(Order=6)
    public City: string;

    // @DataMember(Order=7)
    public StreetAddress: string;

    // @DataMember(Order=8)
    public Zip: string;

    // @DataMember(Order=9)
    public TaxNo: string;

    // @DataMember(Order=10)
    public SalesTaxPercentage?: number;

    // @DataMember(Order=11)
    public Email: string;

    // @DataMember(Order=12)
    public Website: string;

    // @DataMember(Order=13)
    public PhoneNumber: string;

    // @DataMember(Order=14)
    public LogoUrl: string;

    // @DataMember(Order=15)
    public CurrenciesId: number;

    // @DataMember(Order=16)
    public StatusCodesId: number;

    // @DataMember(Order=17)
    public Lat?: number;

    // @DataMember(Order=18)
    public Lng?: number;

    public constructor(init?: Partial<CompaniesLookup>) { (Object as any).assign(this, init); }
}

TypeScript CompaniesLookup DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCompaniesLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CompaniesLookupResponse>
    <City>String</City>
    <CountriesId>0</CountriesId>
    <CurrenciesId>0</CurrenciesId>
    <Email>String</Email>
    <Lat>0</Lat>
    <Lng>0</Lng>
    <LogoUrl>String</LogoUrl>
    <Name>String</Name>
    <PhoneNumber>String</PhoneNumber>
    <RegNo>String</RegNo>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <SalesTaxPercentage>0</SalesTaxPercentage>
    <State>String</State>
    <StatusCodesId>0</StatusCodesId>
    <StreetAddress>String</StreetAddress>
    <TaxNo>String</TaxNo>
    <Website>String</Website>
    <Zip>String</Zip>
  </CompaniesLookupResponse>
</ArrayOfCompaniesLookupResponse>