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 'package:servicestack/servicestack.dart';
import 'dart:collection';

// @DataContract
class CompaniesLookup implements IConvertible
{
    // @DataMember(Order=2)
    String? Name;

    // @DataMember(Order=3)
    String? RegNo;

    // @DataMember(Order=4)
    int? CountriesId;

    // @DataMember(Order=5)
    String? State;

    // @DataMember(Order=6)
    String? City;

    // @DataMember(Order=7)
    String? StreetAddress;

    // @DataMember(Order=8)
    String? Zip;

    // @DataMember(Order=9)
    String? TaxNo;

    // @DataMember(Order=10)
    double? SalesTaxPercentage;

    // @DataMember(Order=11)
    String? Email;

    // @DataMember(Order=12)
    String? Website;

    // @DataMember(Order=13)
    String? PhoneNumber;

    // @DataMember(Order=14)
    String? LogoUrl;

    // @DataMember(Order=15)
    int? CurrenciesId;

    // @DataMember(Order=16)
    int? StatusCodesId;

    // @DataMember(Order=17)
    double? Lat;

    // @DataMember(Order=18)
    double? Lng;

    CompaniesLookup({this.Name,this.RegNo,this.CountriesId,this.State,this.City,this.StreetAddress,this.Zip,this.TaxNo,this.SalesTaxPercentage,this.Email,this.Website,this.PhoneNumber,this.LogoUrl,this.CurrenciesId,this.StatusCodesId,this.Lat,this.Lng});
    CompaniesLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Name = json['Name'];
        RegNo = json['RegNo'];
        CountriesId = json['CountriesId'];
        State = json['State'];
        City = json['City'];
        StreetAddress = json['StreetAddress'];
        Zip = json['Zip'];
        TaxNo = json['TaxNo'];
        SalesTaxPercentage = JsonConverters.toDouble(json['SalesTaxPercentage']);
        Email = json['Email'];
        Website = json['Website'];
        PhoneNumber = json['PhoneNumber'];
        LogoUrl = json['LogoUrl'];
        CurrenciesId = json['CurrenciesId'];
        StatusCodesId = json['StatusCodesId'];
        Lat = JsonConverters.toDouble(json['Lat']);
        Lng = JsonConverters.toDouble(json['Lng']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Name': Name,
        'RegNo': RegNo,
        'CountriesId': CountriesId,
        'State': State,
        'City': City,
        'StreetAddress': StreetAddress,
        'Zip': Zip,
        'TaxNo': TaxNo,
        'SalesTaxPercentage': SalesTaxPercentage,
        'Email': Email,
        'Website': Website,
        'PhoneNumber': PhoneNumber,
        'LogoUrl': LogoUrl,
        'CurrenciesId': CurrenciesId,
        'StatusCodesId': StatusCodesId,
        'Lat': Lat,
        'Lng': Lng
    };

    getTypeName() => "CompaniesLookup";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'CompaniesLookup': TypeInfo(TypeOf.Class, create:() => CompaniesLookup()),
});

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