digitaluapi

CompaniesLookup

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

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class CompaniesLookup
            <DataMember(Order:=2)>
            Public Overridable Property Name As String

            <DataMember(Order:=3)>
            Public Overridable Property RegNo As String

            <DataMember(Order:=4)>
            Public Overridable Property CountriesId As Integer?

            <DataMember(Order:=5)>
            Public Overridable Property State As String

            <DataMember(Order:=6)>
            Public Overridable Property City As String

            <DataMember(Order:=7)>
            Public Overridable Property StreetAddress As String

            <DataMember(Order:=8)>
            Public Overridable Property Zip As String

            <DataMember(Order:=9)>
            Public Overridable Property TaxNo As String

            <DataMember(Order:=10)>
            Public Overridable Property SalesTaxPercentage As Double?

            <DataMember(Order:=11)>
            Public Overridable Property Email As String

            <DataMember(Order:=12)>
            Public Overridable Property Website As String

            <DataMember(Order:=13)>
            Public Overridable Property PhoneNumber As String

            <DataMember(Order:=14)>
            Public Overridable Property LogoUrl As String

            <DataMember(Order:=15)>
            Public Overridable Property CurrenciesId As Integer

            <DataMember(Order:=16)>
            Public Overridable Property StatusCodesId As Long

            <DataMember(Order:=17)>
            Public Overridable Property Lat As Double?

            <DataMember(Order:=18)>
            Public Overridable Property Lng As Double?
        End Class
    End Namespace
End Namespace

VB.NET 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>