digitaluapi

<back to all web services

CompaniesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/companies/{Id}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class CompaniesEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long Id = null;

        @DataMember(Order=2)
        public String Name = null;

        @DataMember(Order=3)
        public String RegNo = null;

        @DataMember(Order=4)
        public Integer CountriesId = null;

        @DataMember(Order=5)
        public String State = null;

        @DataMember(Order=6)
        public String City = null;

        @DataMember(Order=7)
        public String StreetAddress = null;

        @DataMember(Order=8)
        public String Zip = null;

        @DataMember(Order=9)
        public String TaxNo = null;

        @DataMember(Order=10)
        public Double SalesTaxPercentage = null;

        @DataMember(Order=11)
        public String Email = null;

        @DataMember(Order=12)
        public String Website = null;

        @DataMember(Order=13)
        public String PhoneNumber = null;

        @DataMember(Order=14)
        public String LogoUrl = null;

        @DataMember(Order=15)
        @Validate(Validator="NotNull")
        public Integer CurrenciesId = null;

        @DataMember(Order=16)
        @Validate(Validator="NotNull")
        public Long StatusCodesId = null;

        @DataMember(Order=17)
        public Double Lat = null;

        @DataMember(Order=18)
        public Double Lng = null;
        
        public Long getId() { return Id; }
        public CompaniesEdit setId(Long value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CompaniesEdit setName(String value) { this.Name = value; return this; }
        public String getRegNo() { return RegNo; }
        public CompaniesEdit setRegNo(String value) { this.RegNo = value; return this; }
        public Integer getCountriesId() { return CountriesId; }
        public CompaniesEdit setCountriesId(Integer value) { this.CountriesId = value; return this; }
        public String getState() { return State; }
        public CompaniesEdit setState(String value) { this.State = value; return this; }
        public String getCity() { return City; }
        public CompaniesEdit setCity(String value) { this.City = value; return this; }
        public String getStreetAddress() { return StreetAddress; }
        public CompaniesEdit setStreetAddress(String value) { this.StreetAddress = value; return this; }
        public String getZip() { return Zip; }
        public CompaniesEdit setZip(String value) { this.Zip = value; return this; }
        public String getTaxNo() { return TaxNo; }
        public CompaniesEdit setTaxNo(String value) { this.TaxNo = value; return this; }
        public Double getSalesTaxPercentage() { return SalesTaxPercentage; }
        public CompaniesEdit setSalesTaxPercentage(Double value) { this.SalesTaxPercentage = value; return this; }
        public String getEmail() { return Email; }
        public CompaniesEdit setEmail(String value) { this.Email = value; return this; }
        public String getWebsite() { return Website; }
        public CompaniesEdit setWebsite(String value) { this.Website = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public CompaniesEdit setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public String getLogoUrl() { return LogoUrl; }
        public CompaniesEdit setLogoUrl(String value) { this.LogoUrl = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public CompaniesEdit setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public CompaniesEdit setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public Double getLat() { return Lat; }
        public CompaniesEdit setLat(Double value) { this.Lat = value; return this; }
        public Double getLng() { return Lng; }
        public CompaniesEdit setLng(Double value) { this.Lng = value; return this; }
    }

    public static class CompaniesEditResponse
    {
        @DataMember(Order=1)
        public Long Id = null;

        @DataMember(Order=2)
        public String Name = null;

        @DataMember(Order=3)
        public String RegNo = null;

        @DataMember(Order=4)
        public Integer CountriesId = null;

        @DataMember(Order=5)
        public String State = null;

        @DataMember(Order=6)
        public String City = null;

        @DataMember(Order=7)
        public String StreetAddress = null;

        @DataMember(Order=8)
        public String Zip = null;

        @DataMember(Order=9)
        public String TaxNo = null;

        @DataMember(Order=10)
        public Double SalesTaxPercentage = null;

        @DataMember(Order=11)
        public String Email = null;

        @DataMember(Order=12)
        public String Website = null;

        @DataMember(Order=13)
        public String PhoneNumber = null;

        @DataMember(Order=14)
        public String LogoUrl = null;

        @DataMember(Order=15)
        public Integer CurrenciesId = null;

        @DataMember(Order=16)
        public Long StatusCodesId = null;

        @DataMember(Order=17)
        public Double Lat = null;

        @DataMember(Order=18)
        public Double Lng = null;

        @DataMember(Order=20)
        public ResponseStatus ResponseStatus = null;
        
        public Long getId() { return Id; }
        public CompaniesEditResponse setId(Long value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CompaniesEditResponse setName(String value) { this.Name = value; return this; }
        public String getRegNo() { return RegNo; }
        public CompaniesEditResponse setRegNo(String value) { this.RegNo = value; return this; }
        public Integer getCountriesId() { return CountriesId; }
        public CompaniesEditResponse setCountriesId(Integer value) { this.CountriesId = value; return this; }
        public String getState() { return State; }
        public CompaniesEditResponse setState(String value) { this.State = value; return this; }
        public String getCity() { return City; }
        public CompaniesEditResponse setCity(String value) { this.City = value; return this; }
        public String getStreetAddress() { return StreetAddress; }
        public CompaniesEditResponse setStreetAddress(String value) { this.StreetAddress = value; return this; }
        public String getZip() { return Zip; }
        public CompaniesEditResponse setZip(String value) { this.Zip = value; return this; }
        public String getTaxNo() { return TaxNo; }
        public CompaniesEditResponse setTaxNo(String value) { this.TaxNo = value; return this; }
        public Double getSalesTaxPercentage() { return SalesTaxPercentage; }
        public CompaniesEditResponse setSalesTaxPercentage(Double value) { this.SalesTaxPercentage = value; return this; }
        public String getEmail() { return Email; }
        public CompaniesEditResponse setEmail(String value) { this.Email = value; return this; }
        public String getWebsite() { return Website; }
        public CompaniesEditResponse setWebsite(String value) { this.Website = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public CompaniesEditResponse setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public String getLogoUrl() { return LogoUrl; }
        public CompaniesEditResponse setLogoUrl(String value) { this.LogoUrl = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public CompaniesEditResponse setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public CompaniesEditResponse setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public Double getLat() { return Lat; }
        public CompaniesEditResponse setLat(Double value) { this.Lat = value; return this; }
        public Double getLng() { return Lng; }
        public CompaniesEditResponse setLng(Double value) { this.Lng = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CompaniesEditResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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
		}
	}
}