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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @DataContract
    public static class CompaniesLookup
    {
        @DataMember(Order=2)
        public String Name = null;

        @DataMember(Order=3)
        public String RegNo = null;

        @DataMember(Order=4)
        public Integer CountriesId = null;

        @DataMember(Order=5)
        public String State = null;

        @DataMember(Order=6)
        public String City = null;

        @DataMember(Order=7)
        public String StreetAddress = null;

        @DataMember(Order=8)
        public String Zip = null;

        @DataMember(Order=9)
        public String TaxNo = null;

        @DataMember(Order=10)
        public Double SalesTaxPercentage = null;

        @DataMember(Order=11)
        public String Email = null;

        @DataMember(Order=12)
        public String Website = null;

        @DataMember(Order=13)
        public String PhoneNumber = null;

        @DataMember(Order=14)
        public String LogoUrl = null;

        @DataMember(Order=15)
        public Integer CurrenciesId = null;

        @DataMember(Order=16)
        public Long StatusCodesId = null;

        @DataMember(Order=17)
        public Double Lat = null;

        @DataMember(Order=18)
        public Double Lng = null;
        
        public String getName() { return Name; }
        public CompaniesLookup setName(String value) { this.Name = value; return this; }
        public String getRegNo() { return RegNo; }
        public CompaniesLookup setRegNo(String value) { this.RegNo = value; return this; }
        public Integer getCountriesId() { return CountriesId; }
        public CompaniesLookup setCountriesId(Integer value) { this.CountriesId = value; return this; }
        public String getState() { return State; }
        public CompaniesLookup setState(String value) { this.State = value; return this; }
        public String getCity() { return City; }
        public CompaniesLookup setCity(String value) { this.City = value; return this; }
        public String getStreetAddress() { return StreetAddress; }
        public CompaniesLookup setStreetAddress(String value) { this.StreetAddress = value; return this; }
        public String getZip() { return Zip; }
        public CompaniesLookup setZip(String value) { this.Zip = value; return this; }
        public String getTaxNo() { return TaxNo; }
        public CompaniesLookup setTaxNo(String value) { this.TaxNo = value; return this; }
        public Double getSalesTaxPercentage() { return SalesTaxPercentage; }
        public CompaniesLookup setSalesTaxPercentage(Double value) { this.SalesTaxPercentage = value; return this; }
        public String getEmail() { return Email; }
        public CompaniesLookup setEmail(String value) { this.Email = value; return this; }
        public String getWebsite() { return Website; }
        public CompaniesLookup setWebsite(String value) { this.Website = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public CompaniesLookup setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public String getLogoUrl() { return LogoUrl; }
        public CompaniesLookup setLogoUrl(String value) { this.LogoUrl = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public CompaniesLookup setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public CompaniesLookup setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public Double getLat() { return Lat; }
        public CompaniesLookup setLat(Double value) { this.Lat = value; return this; }
        public Double getLng() { return Lng; }
        public CompaniesLookup setLng(Double value) { this.Lng = value; return this; }
    }

}

Java 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>