AIM Web Services

EditContactRecordRequest

EditContactRecord web service.

The following routes are available for this service:
POST	/api/EditContactRecord

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * EditContactRecord web service.
    */
    @DataContract
    public static class EditContactRecordRequest extends BaseSecureRequest
    {
        @DataMember
        public String RefNumber = null;

        @DataMember
        public String Contact = null;

        @DataMember
        public Integer CustomerAcct = null;

        @DataMember
        public Long ActionId = null;

        @DataMember
        public Date ActionDate = null;

        @DataMember
        public Boolean PopUp = null;

        @DataMember
        public Long TopicId = null;

        @DataMember
        public Boolean Closed = null;

        @DataMember
        public Date ClosedDate = null;

        @DataMember
        public Integer ColorValue = null;

        @DataMember
        public String LanID = null;

        @DataMember
        public Boolean FormattedNotes = null;

        @DataMember
        public Boolean AppendNotes = null;

        @DataMember
        public String Note1 = null;

        @DataMember
        public String Note2 = null;

        @DataMember
        public String Note3 = null;

        @DataMember
        public ArrayList<AttributeValuePair> Attributes = null;

        @DataMember
        public ArrayList<FileAttachment> NewAttachments = null;
        
        public String getRefNumber() { return RefNumber; }
        public EditContactRecordRequest setRefNumber(String value) { this.RefNumber = value; return this; }
        public String getContact() { return Contact; }
        public EditContactRecordRequest setContact(String value) { this.Contact = value; return this; }
        public Integer getCustomerAcct() { return CustomerAcct; }
        public EditContactRecordRequest setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
        public Long getActionId() { return ActionId; }
        public EditContactRecordRequest setActionId(Long value) { this.ActionId = value; return this; }
        public Date getActionDate() { return ActionDate; }
        public EditContactRecordRequest setActionDate(Date value) { this.ActionDate = value; return this; }
        public Boolean isPopUp() { return PopUp; }
        public EditContactRecordRequest setPopUp(Boolean value) { this.PopUp = value; return this; }
        public Long getTopicId() { return TopicId; }
        public EditContactRecordRequest setTopicId(Long value) { this.TopicId = value; return this; }
        public Boolean isClosed() { return Closed; }
        public EditContactRecordRequest setClosed(Boolean value) { this.Closed = value; return this; }
        public Date getClosedDate() { return ClosedDate; }
        public EditContactRecordRequest setClosedDate(Date value) { this.ClosedDate = value; return this; }
        public Integer getColorValue() { return ColorValue; }
        public EditContactRecordRequest setColorValue(Integer value) { this.ColorValue = value; return this; }
        public String getLanID() { return LanID; }
        public EditContactRecordRequest setLanID(String value) { this.LanID = value; return this; }
        public Boolean isFormattedNotes() { return FormattedNotes; }
        public EditContactRecordRequest setFormattedNotes(Boolean value) { this.FormattedNotes = value; return this; }
        public Boolean isAppendNotes() { return AppendNotes; }
        public EditContactRecordRequest setAppendNotes(Boolean value) { this.AppendNotes = value; return this; }
        public String getNote1() { return Note1; }
        public EditContactRecordRequest setNote1(String value) { this.Note1 = value; return this; }
        public String getNote2() { return Note2; }
        public EditContactRecordRequest setNote2(String value) { this.Note2 = value; return this; }
        public String getNote3() { return Note3; }
        public EditContactRecordRequest setNote3(String value) { this.Note3 = value; return this; }
        public ArrayList<AttributeValuePair> getAttributes() { return Attributes; }
        public EditContactRecordRequest setAttributes(ArrayList<AttributeValuePair> value) { this.Attributes = value; return this; }
        public ArrayList<FileAttachment> getNewAttachments() { return NewAttachments; }
        public EditContactRecordRequest setNewAttachments(ArrayList<FileAttachment> value) { this.NewAttachments = 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 AttributeValuePair
    {
        @DataMember
        public String Name = null;

        @DataMember
        public String Value = null;
        
        public String getName() { return Name; }
        public AttributeValuePair setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public AttributeValuePair setValue(String value) { this.Value = value; return this; }
    }

    @DataContract
    public static class FileAttachment
    {
        @DataMember
        public String FileName = null;

        @DataMember
        public String Base64Contents = null;
        
        public String getFileName() { return FileName; }
        public FileAttachment setFileName(String value) { this.FileName = value; return this; }
        public String getBase64Contents() { return Base64Contents; }
        public FileAttachment setBase64Contents(String value) { this.Base64Contents = value; return this; }
    }

    @DataContract
    public static class EditContactRecordResponse 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 EditContactRecordRequest DTOs

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

HTTP + XML

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

POST /api/EditContactRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EditContactRecordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <ActionDate>0001-01-01T00:00:00</ActionDate>
  <ActionId>0</ActionId>
  <AppendNotes>false</AppendNotes>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:AttributeValuePair>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:AttributeValuePair>
  </Attributes>
  <Closed>false</Closed>
  <ClosedDate>0001-01-01T00:00:00</ClosedDate>
  <ColorValue>0</ColorValue>
  <Contact>String</Contact>
  <CustomerAcct>0</CustomerAcct>
  <FormattedNotes>false</FormattedNotes>
  <LanID>String</LanID>
  <NewAttachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:FileAttachment>
      <d2p1:Base64Contents>String</d2p1:Base64Contents>
      <d2p1:FileName>String</d2p1:FileName>
    </d2p1:FileAttachment>
  </NewAttachments>
  <Note1>String</Note1>
  <Note2>String</Note2>
  <Note3>String</Note3>
  <PopUp>false</PopUp>
  <RefNumber>String</RefNumber>
  <TopicId>0</TopicId>
</EditContactRecordRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EditContactRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</EditContactRecordResponse>