AIM Web Services

EditContactRecordRequest

EditContactRecord web service.

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class AttributeValuePair
    {
        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string Value { get; set; }
    }

    [DataContract]
    public partial class FileAttachment
    {
        [DataMember]
        public virtual string FileName { get; set; }

        [DataMember]
        public virtual string Base64Contents { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///EditContactRecord web service.
    ///</summary>
    [DataContract]
    public partial class EditContactRecordRequest
        : BaseSecureRequest
    {
        public EditContactRecordRequest()
        {
            Attributes = new List<AttributeValuePair>{};
            NewAttachments = new List<FileAttachment>{};
        }

        [DataMember]
        public virtual string RefNumber { get; set; }

        [DataMember]
        public virtual string Contact { get; set; }

        [DataMember]
        public virtual int? CustomerAcct { get; set; }

        [DataMember]
        public virtual long? ActionId { get; set; }

        [DataMember]
        public virtual DateTime? ActionDate { get; set; }

        [DataMember]
        public virtual bool? PopUp { get; set; }

        [DataMember]
        public virtual long? TopicId { get; set; }

        [DataMember]
        public virtual bool? Closed { get; set; }

        [DataMember]
        public virtual DateTime? ClosedDate { get; set; }

        [DataMember]
        public virtual int? ColorValue { get; set; }

        [DataMember]
        public virtual string LanID { get; set; }

        [DataMember]
        public virtual bool FormattedNotes { get; set; }

        [DataMember]
        public virtual bool AppendNotes { get; set; }

        [DataMember]
        public virtual string Note1 { get; set; }

        [DataMember]
        public virtual string Note2 { get; set; }

        [DataMember]
        public virtual string Note3 { get; set; }

        [DataMember]
        public virtual List<AttributeValuePair> Attributes { get; set; }

        [DataMember]
        public virtual List<FileAttachment> NewAttachments { get; set; }
    }

    [DataContract]
    public partial class EditContactRecordResponse
        : BaseResponse
    {
    }

}

C# 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>