AIM Web Services

<back to all web services

UpdateCustomerRequest

UpdateCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/UpdateCustomer
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * UpdateCustomerRequires active-e Customer Service.
    */
    @DataContract
    public static class UpdateCustomerRequest extends BaseSecureRequest
    {
        /**
        * Customer Acct #
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Customer Acct #", Format="int32", IsRequired=true, Name="Acct", ParameterType="query")
        public Integer Acct = null;

        /**
        * Location ID
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Location ID", Format="int64", Name="LocationId", ParameterType="query")
        public Long LocationId = null;

        /**
        * Customer Default Id
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", Name="CustomerDefaultId", ParameterType="query")
        public Long CustomerDefaultId = null;

        /**
        * Tax Authority Id
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", Name="TaxAuthorityId", ParameterType="query")
        public Long TaxAuthorityId = null;

        @DataMember
        public String Name = null;

        @DataMember
        public String Attn = null;

        @DataMember
        public String Address1 = null;

        @DataMember
        public String Address2 = null;

        @DataMember
        public String City = null;

        @DataMember
        public String State = null;

        @DataMember
        public String Zip = null;

        @DataMember
        public String Country = null;

        @DataMember
        public String HomePhone = null;

        @DataMember
        public String WorkPhone = null;

        @DataMember
        public String CellPhone = null;

        @DataMember
        public String Employer = null;

        @DataMember
        public String SS = null;

        @DataMember
        public String Email = null;

        /**
        * Email Method. Set this to Word, PDF, HTML, or None
        */
        @DataMember
        @ApiMember(DataType="string", Description="Email Method. Set this to Word, PDF, HTML, or None", Name="EmailMethod", ParameterType="query")
        public String EmailMethod = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public LicenseInfo DriversLicenseInfo = null;

        /**
        * If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.
        */
        @DataMember
        @ApiMember(DataType="bool", Description="If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.", Name="RefreshCustomerDefaults", ParameterType="query")
        public Boolean RefreshCustomerDefaults = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
        public ArrayList<FormInput> FormInputList = null;
        
        public Integer getAcct() { return Acct; }
        public UpdateCustomerRequest setAcct(Integer value) { this.Acct = value; return this; }
        public Long getLocationId() { return LocationId; }
        public UpdateCustomerRequest setLocationId(Long value) { this.LocationId = value; return this; }
        public Long getCustomerDefaultId() { return CustomerDefaultId; }
        public UpdateCustomerRequest setCustomerDefaultId(Long value) { this.CustomerDefaultId = value; return this; }
        public Long getTaxAuthorityId() { return TaxAuthorityId; }
        public UpdateCustomerRequest setTaxAuthorityId(Long value) { this.TaxAuthorityId = value; return this; }
        public String getName() { return Name; }
        public UpdateCustomerRequest setName(String value) { this.Name = value; return this; }
        public String getAttn() { return Attn; }
        public UpdateCustomerRequest setAttn(String value) { this.Attn = value; return this; }
        public String getAddress1() { return Address1; }
        public UpdateCustomerRequest setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public UpdateCustomerRequest setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public UpdateCustomerRequest setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public UpdateCustomerRequest setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public UpdateCustomerRequest setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public UpdateCustomerRequest setCountry(String value) { this.Country = value; return this; }
        public String getHomePhone() { return HomePhone; }
        public UpdateCustomerRequest setHomePhone(String value) { this.HomePhone = value; return this; }
        public String getWorkPhone() { return WorkPhone; }
        public UpdateCustomerRequest setWorkPhone(String value) { this.WorkPhone = value; return this; }
        public String getCellPhone() { return CellPhone; }
        public UpdateCustomerRequest setCellPhone(String value) { this.CellPhone = value; return this; }
        public String getEmployer() { return Employer; }
        public UpdateCustomerRequest setEmployer(String value) { this.Employer = value; return this; }
        public String getSs() { return SS; }
        public UpdateCustomerRequest setSs(String value) { this.SS = value; return this; }
        public String getEmail() { return Email; }
        public UpdateCustomerRequest setEmail(String value) { this.Email = value; return this; }
        public String getEmailMethod() { return EmailMethod; }
        public UpdateCustomerRequest setEmailMethod(String value) { this.EmailMethod = value; return this; }
        public String getNotes() { return Notes; }
        public UpdateCustomerRequest setNotes(String value) { this.Notes = value; return this; }
        public LicenseInfo getDriversLicenseInfo() { return DriversLicenseInfo; }
        public UpdateCustomerRequest setDriversLicenseInfo(LicenseInfo value) { this.DriversLicenseInfo = value; return this; }
        public Boolean isRefreshCustomerDefaults() { return RefreshCustomerDefaults; }
        public UpdateCustomerRequest setRefreshCustomerDefaults(Boolean value) { this.RefreshCustomerDefaults = value; return this; }
        public ArrayList<FormInput> getFormInputList() { return FormInputList; }
        public UpdateCustomerRequest setFormInputList(ArrayList<FormInput> value) { this.FormInputList = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class LicenseInfo
    {
        @DataMember
        public String Number = null;

        @DataMember
        public String Height = null;

        @DataMember
        public String Weight = null;

        @DataMember
        public String Hair = null;

        @DataMember
        public String Eyes = null;

        @DataMember
        public String Expiration = null;

        @DataMember
        public String Birthday = null;

        @DataMember
        public String Ethnicity = null;

        @DataMember
        public String Gender = null;

        @DataMember
        public String State = null;
        
        public String getNumber() { return Number; }
        public LicenseInfo setNumber(String value) { this.Number = value; return this; }
        public String getHeight() { return Height; }
        public LicenseInfo setHeight(String value) { this.Height = value; return this; }
        public String getWeight() { return Weight; }
        public LicenseInfo setWeight(String value) { this.Weight = value; return this; }
        public String getHair() { return Hair; }
        public LicenseInfo setHair(String value) { this.Hair = value; return this; }
        public String getEyes() { return Eyes; }
        public LicenseInfo setEyes(String value) { this.Eyes = value; return this; }
        public String getExpiration() { return Expiration; }
        public LicenseInfo setExpiration(String value) { this.Expiration = value; return this; }
        public String getBirthday() { return Birthday; }
        public LicenseInfo setBirthday(String value) { this.Birthday = value; return this; }
        public String getEthnicity() { return Ethnicity; }
        public LicenseInfo setEthnicity(String value) { this.Ethnicity = value; return this; }
        public String getGender() { return Gender; }
        public LicenseInfo setGender(String value) { this.Gender = value; return this; }
        public String getState() { return State; }
        public LicenseInfo setState(String value) { this.State = value; return this; }
    }

    @DataContract(Name="FormInput")
    public static class FormInput
    {
        /**
        * Field Name of the Input Field
        */
        @DataMember
        @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
        public String Key = null;

        /**
        * Value of the Input Field.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
        public String Value = null;

        /**
        * Whether or not the field is encryped with the C2B encryption key.
        */
        @DataMember
        @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
        public Boolean Encrypted = null;
        
        public String getKey() { return Key; }
        public FormInput setKey(String value) { this.Key = value; return this; }
        public String getValue() { return Value; }
        public FormInput setValue(String value) { this.Value = value; return this; }
        public Boolean isEncrypted() { return Encrypted; }
        public FormInput setEncrypted(Boolean value) { this.Encrypted = value; return this; }
    }

    @DataContract
    public static class UpdateCustomerResponse extends BaseResponse
    {
        
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java UpdateCustomerRequest DTOs

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

HTTP + OTHER

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

POST /api/UpdateCustomer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Acct":0,"LocationId":0,"CustomerDefaultId":0,"TaxAuthorityId":0,"Name":"String","Attn":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","HomePhone":"String","WorkPhone":"String","CellPhone":"String","Employer":"String","SS":"String","Email":"String","EmailMethod":"String","Notes":"String","DriversLicenseInfo":{"Number":"String","Height":"String","Weight":"String","Hair":"String","Eyes":"String","Expiration":"String","Birthday":"String","Ethnicity":"String","Gender":"String","State":"String"},"RefreshCustomerDefaults":false,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}