AIM Web Services

<back to all web services

SearchCustomersRequest

SearchCustomers
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/SearchCustomers
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 BindableObject() = 
        class end

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerDefaultInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type TaxAuthorityInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type LocationInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

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

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

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type AdditionalDetail() = 
        [<DataMember>]
        member val CreationDate:DateTime = new DateTime() with get,set

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

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

        [<DataMember>]
        member val CustomerDefault:CustomerDefaultInfo = null with get,set

        [<DataMember>]
        member val TaxAuthority:TaxAuthorityInfo = null with get,set

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

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

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

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

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

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

        [<DataMember>]
        member val Location:LocationInfo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerSearchRecord() = 
        inherit BindableObject()
        [<DataMember>]
        member val Pk:Int64 = new Int64() with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember>]
        member val AdditionalDetails:AdditionalDetail = null with get,set

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type SearchCustomersResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val StartOffset:Int64 = new Int64() with get,set

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

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

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

        [<DataMember>]
        member val Customers:ResizeArray<CustomerSearchRecord> = new ResizeArray<CustomerSearchRecord>() 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>
    ///SearchCustomersRequires active-e Customer Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type SearchCustomersRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val SearchString:String = null with get,set

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

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

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

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

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

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

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

F# SearchCustomersRequest 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.

GET /api/SearchCustomers HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"StartOffset":0,"RecordCount":0,"RemainingRecords":0,"TotalRecords":0,"Customers":[{"Pk":0,"Acct":0,"Last":"String","Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Phone":"String","Email":"String","OpenInvoices":false,"RentalActivity":false,"StLoc":"String","Hold":false,"Barcode":"String","Color":0,"DependantInfo":[{"Name":"String","OnlineId":"String","SchoolDistrict":"String","School":"String","Id":0}],"AdditionalDetails":{"Notes":"String","CustomerDefault":{"Id":0,"Desc":"String","ShortDesc":"String"},"TaxAuthority":{"Id":0,"Desc":"String","ShortDesc":"String"},"CanCharge":false,"PopupNotes":"String","DlNumber":"String","Phone2":"String","Phone3":"String","Phone4":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0}},"MatchedOn":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}