AIM Web Services

<back to all web services

SearchContactManagementRequest

SearchContactManagement web service.

The following routes are available for this service:
POST, GET/api/SearchContactManagement
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AttributeValuePair() = 
        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Value:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ContactManagementRecord() = 
        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val DateTime:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Contact:String = null with get,set

        [<DataMember>]
        member val CusAcct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val ActionId:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val ActionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val PopUp:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val TopicId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

        [<DataMember>]
        member val Closed:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ClosedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val ColorValue:Int32 = new Int32() with get,set

        [<DataMember>]
        member val LanId:String = null with get,set

        [<DataMember>]
        member val FormattedNotes:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Note1:String = null with get,set

        [<DataMember>]
        member val Note2:String = null with get,set

        [<DataMember>]
        member val Note3:String = null with get,set

        [<DataMember>]
        member val Attributes:ResizeArray<AttributeValuePair> = new ResizeArray<AttributeValuePair>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SearchContactManagementResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val ContactManagementRecords:ResizeArray<ContactManagementRecord> = new ResizeArray<ContactManagementRecord>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///SearchContactManagement web service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type SearchContactManagementRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val FormattedNotes:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///If sent, all other search parameters will be ignored.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="If sent, all other search parameters will be ignored.", Name="Ref", ParameterType="query")>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val DateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val IncludeClosed:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="SearchString", ParameterType="query")>]
        member val SearchString:String = null with get,set

        [<DataMember>]
        member val ActionId:Nullable<Int64> = new Nullable<Int64>() with get,set

F# SearchContactManagementRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"FormattedNotes":false,"Ref":"String","Acct":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeClosed":false,"SearchString":"String","ActionId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"ContactManagementRecords":[{"Ref":"String","Contact":"String","CusAcct":0,"ActionId":0,"Status":"String","ActionDate":"0001-01-01T00:00:00.0000000","PopUp":false,"TopicId":0,"Topic":"String","Closed":false,"ClosedDate":"0001-01-01T00:00:00.0000000","ColorValue":0,"LanId":"String","FormattedNotes":false,"Note1":"String","Note2":"String","Note3":"String","Attributes":[{"Name":"String","Value":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}