AIM Web Services

AddContactRecordRequest

AddContactRecord web service.

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

**AddContactRecordRequest** Parameters:
Name	Parameter	Data Type	Required
Contact	body	string	No
CustomerAcct	body	int	No
ActionId	body	long	No
ActionDate	body	DateTime?	No
PopUp	body	bool	No
TopicId	body	long?	No
Closed	body	bool	No
ClosedDate	body	DateTime?	No
ColorValue	body	int	No
OverrideLanID	body	string	No
FormattedNotes	body	bool	No
Note1	body	string	No
Note2	body	string	No
Note3	body	string	No
Attributes	body	List<AttributeValuePair>	No
Attachments	body	List<FileAttachment>	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**AttributeValuePair** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**FileAttachment** Parameters:
Name	Parameter	Data Type	Required	Description
FileName	form	string	No
Base64Contents	form	string	No

**AddContactRecordResponse** Parameters:
Name	Parameter	Data Type	Required	Description
RefNumber	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

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/AddContactRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddContactRecordRequest 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>
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:FileAttachment>
      <d2p1:Base64Contents>String</d2p1:Base64Contents>
      <d2p1:FileName>String</d2p1:FileName>
    </d2p1:FileAttachment>
  </Attachments>
  <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>
  <Note1>String</Note1>
  <Note2>String</Note2>
  <Note3>String</Note3>
  <OverrideLanID>String</OverrideLanID>
  <PopUp>false</PopUp>
  <TopicId>0</TopicId>
</AddContactRecordRequest>

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

<AddContactRecordResponse 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>
  <RefNumber>String</RefNumber>
</AddContactRecordResponse>