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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Name":"String","RegNo":"String","CountriesId":0,"State":"String","City":"String","StreetAddress":"String","Zip":"String","TaxNo":"String","SalesTaxPercentage":0,"Email":"String","Website":"String","PhoneNumber":"String","LogoUrl":"String","CurrenciesId":0,"StatusCodesId":0,"Lat":0,"Lng":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Name":"String","RegNo":"String","CountriesId":0,"State":"String","City":"String","StreetAddress":"String","Zip":"String","TaxNo":"String","SalesTaxPercentage":0,"Email":"String","Website":"String","PhoneNumber":"String","LogoUrl":"String","CurrenciesId":0,"StatusCodesId":0,"Lat":0,"Lng":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}