digitaluapi

CompaniesEdit

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

The following routes are available for this service:
PUT	/companies/{Id}

"use strict";
export class CompaniesEditResponse {
    /** @param {{Id?:number,Name?:string,RegNo?:string,CountriesId?:number,State?:string,City?:string,StreetAddress?:string,Zip?:string,TaxNo?:string,SalesTaxPercentage?:number,Email?:string,Website?:string,PhoneNumber?:string,LogoUrl?:string,CurrenciesId?:number,StatusCodesId?:number,Lat?:number,Lng?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    RegNo;
    /** @type {?number} */
    CountriesId;
    /** @type {string} */
    State;
    /** @type {string} */
    City;
    /** @type {string} */
    StreetAddress;
    /** @type {string} */
    Zip;
    /** @type {string} */
    TaxNo;
    /** @type {?number} */
    SalesTaxPercentage;
    /** @type {string} */
    Email;
    /** @type {string} */
    Website;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    LogoUrl;
    /** @type {number} */
    CurrenciesId;
    /** @type {number} */
    StatusCodesId;
    /** @type {?number} */
    Lat;
    /** @type {?number} */
    Lng;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CompaniesEdit {
    /** @param {{Id?:number,Name?:string,RegNo?:string,CountriesId?:number,State?:string,City?:string,StreetAddress?:string,Zip?:string,TaxNo?:string,SalesTaxPercentage?:number,Email?:string,Website?:string,PhoneNumber?:string,LogoUrl?:string,CurrenciesId?:number,StatusCodesId?:number,Lat?:number,Lng?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    RegNo;
    /** @type {?number} */
    CountriesId;
    /** @type {string} */
    State;
    /** @type {string} */
    City;
    /** @type {string} */
    StreetAddress;
    /** @type {string} */
    Zip;
    /** @type {string} */
    TaxNo;
    /** @type {?number} */
    SalesTaxPercentage;
    /** @type {string} */
    Email;
    /** @type {string} */
    Website;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    LogoUrl;
    /** @type {number} */
    CurrenciesId;
    /** @type {number} */
    StatusCodesId;
    /** @type {?number} */
    Lat;
    /** @type {?number} */
    Lng;
}

JavaScript CompaniesEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /companies/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	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/jsv
Content-Length: length

{
	Id: 0,
	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
		}
	}
}