digitaluapi

<back to all web services

CompaniesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/companies
import 'package:servicestack/servicestack.dart';

class CompaniesAddResponse 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;

    // @DataMember(Order=20)
    ResponseStatus? ResponseStatus;

    CompaniesAddResponse({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,this.ResponseStatus});
    CompaniesAddResponse.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']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        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,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class CompaniesAdd 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)
    // @Validate(Validator="NotNull")
    int? CurrenciesId;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    int? StatusCodesId;

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

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

    CompaniesAdd({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});
    CompaniesAdd.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() => "CompaniesAdd";
    TypeContext? context = _ctx;
}

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

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

POST /companies HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CompaniesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Name>String</Name>
  <RegNo>String</RegNo>
  <CountriesId>0</CountriesId>
  <State>String</State>
  <City>String</City>
  <StreetAddress>String</StreetAddress>
  <Zip>String</Zip>
  <TaxNo>String</TaxNo>
  <SalesTaxPercentage>0</SalesTaxPercentage>
  <Email>String</Email>
  <Website>String</Website>
  <PhoneNumber>String</PhoneNumber>
  <LogoUrl>String</LogoUrl>
  <CurrenciesId>0</CurrenciesId>
  <StatusCodesId>0</StatusCodesId>
  <Lat>0</Lat>
  <Lng>0</Lng>
</CompaniesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompaniesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <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:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SalesTaxPercentage>0</SalesTaxPercentage>
  <State>String</State>
  <StatusCodesId>0</StatusCodesId>
  <StreetAddress>String</StreetAddress>
  <TaxNo>String</TaxNo>
  <Website>String</Website>
  <Zip>String</Zip>
</CompaniesAddResponse>