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.*


/**
* UpdateCustomerRequires active-e Customer Service.
*/
@DataContract
open class UpdateCustomerRequest : BaseSecureRequest()
{
    /**
    * Customer Acct #
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Customer Acct #", Format="int32", IsRequired=true, Name="Acct", ParameterType="query")
    var Acct:Int? = null

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

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

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

    @DataMember
    var Name:String? = null

    @DataMember
    var Attn:String? = null

    @DataMember
    var Address1:String? = null

    @DataMember
    var Address2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var State:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Country:String? = null

    @DataMember
    var HomePhone:String? = null

    @DataMember
    var WorkPhone:String? = null

    @DataMember
    var CellPhone:String? = null

    @DataMember
    var Employer:String? = null

    @DataMember
    var SS:String? = null

    @DataMember
    var Email:String? = 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")
    var EmailMethod:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var DriversLicenseInfo:LicenseInfo? = 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")
    var RefreshCustomerDefaults:Boolean? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    var FormInputList:ArrayList<FormInput> = ArrayList<FormInput>()
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class LicenseInfo
{
    @DataMember
    var Number:String? = null

    @DataMember
    var Height:String? = null

    @DataMember
    var Weight:String? = null

    @DataMember
    var Hair:String? = null

    @DataMember
    var Eyes:String? = null

    @DataMember
    var Expiration:String? = null

    @DataMember
    var Birthday:String? = null

    @DataMember
    var Ethnicity:String? = null

    @DataMember
    var Gender:String? = null

    @DataMember
    var State:String? = null
}

@DataContract(Name="FormInput")
open 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")
    var Key:String? = null

    /**
    * Value of the Input Field.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    var Value:String? = 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")
    var Encrypted:Boolean? = null
}

@DataContract
open class UpdateCustomerResponse : BaseResponse()
{
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

Kotlin 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"}}