AS Server - API - BusinessContact

Default

businessContactSearch

BusinessContact_Search


/BusinessContact/Search

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,text/json,application/xml,text/xml" \
 -H "Content-Type: application/json,text/json,application/xml,text/xml,application/x-www-form-urlencoded" \
 "https://api.dev.spenda.co/api/BusinessContact/Search" \
 -d '{
  "ParentID" : 1,
  "Types" : [ "Types", "Types" ],
  "IsApprovedForPOS" : true,
  "IsApprovedForWeb" : true,
  "AdaptorID" : 2,
  "SortField" : "SortField",
  "IsExactMatch" : true,
  "CategoryIDs" : [ 7, 7 ],
  "GetCountOnly" : true,
  "SearchString" : "SearchString",
  "IncludeDeleted" : true,
  "IncludeSystemTasks" : true,
  "StartDate" : "2000-01-23T04:56:07.000+00:00",
  "TenantID" : 1,
  "IgnoreID" : 6,
  "IsShowFavourites" : true,
  "IsHierarchicalSort" : true,
  "UserID" : 6,
  "Search" : "Search",
  "SortAsc" : true,
  "GUIDs" : [ "GUIDs", "GUIDs" ],
  "IncludeLogs" : true,
  "ID" : 4,
  "LinkedSupplierID" : 2,
  "Status" : [ "Status", "Status" ],
  "CategoryID" : 5,
  "WebsiteID" : 1,
  "IsHidden" : true,
  "GroupBy" : "GroupBy",
  "BrandIDs" : [ 9, 9 ],
  "LastRowNumber" : 7,
  "MaxResults" : 1,
  "EndDate" : "2000-01-23T04:56:07.000+00:00",
  "Statuses" : [ 0, 0 ],
  "StatusStrings" : [ "StatusStrings", "StatusStrings" ],
  "IsGetBasicInfo" : true,
  "BatchStatus" : "BatchStatus",
  "DatePeriod" : "DatePeriod",
  "IDs" : [ 3, 3 ],
  "IsSystem" : true,
  "SearchNameOnly" : true,
  "IsApprovedForService" : true,
  "TransactionTypeDatTypeID" : 5
}' \
 -d 'Custom MIME type example not yet supported: text/json' \
 -d '<SearchFilter>
  <Statuses>123</Statuses>
  <StatusStrings>aeiou</StatusStrings>
  <Status>aeiou</Status>
  <SearchString>aeiou</SearchString>
  <SearchNameOnly>true</SearchNameOnly>
  <Search>aeiou</Search>
  <StartDate>2000-01-23T04:56:07.000Z</StartDate>
  <EndDate>2000-01-23T04:56:07.000Z</EndDate>
  <DatePeriod>aeiou</DatePeriod>
  <IsExactMatch>true</IsExactMatch>
  <IsGetBasicInfo>true</IsGetBasicInfo>
  <IncludeDeleted>true</IncludeDeleted>
  <IncludeLogs>true</IncludeLogs>
  <IgnoreID>123</IgnoreID>
  <ParentID>123</ParentID>
  <GetCountOnly>true</GetCountOnly>
  <TransactionTypeDatTypeID>123</TransactionTypeDatTypeID>
  <CategoryID>123</CategoryID>
  <AdaptorID>123</AdaptorID>
  <CategoryIDs>123</CategoryIDs>
  <BrandIDs>123</BrandIDs>
  <IDs>123</IDs>
  <GUIDs>aeiou</GUIDs>
  <LinkedSupplierID>123</LinkedSupplierID>
  <IsApprovedForPOS>true</IsApprovedForPOS>
  <IsApprovedForWeb>true</IsApprovedForWeb>
  <IsApprovedForService>true</IsApprovedForService>
  <ID>123</ID>
  <IsHierarchicalSort>true</IsHierarchicalSort>
  <Types>aeiou</Types>
  <IsShowFavourites>true</IsShowFavourites>
  <IsHidden>true</IsHidden>
  <IncludeSystemTasks>true</IncludeSystemTasks>
  <IsSystem>true</IsSystem>
  <BatchStatus>aeiou</BatchStatus>
  <SortField>aeiou</SortField>
  <SortAsc>true</SortAsc>
  <GroupBy>aeiou</GroupBy>
  <LastRowNumber>123456789</LastRowNumber>
  <MaxResults>123</MaxResults>
  <TenantID>123</TenantID>
  <WebsiteID>123</WebsiteID>
  <UserID>123</UserID>
</SearchFilter>' \
 -d 'Custom MIME type example not yet supported: text/xml' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        SearchFilter searchFilter = {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0}; // SearchFilter | 

        try {
            Object result = apiInstance.businessContactSearch(searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#businessContactSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final SearchFilter searchFilter = new SearchFilter(); // SearchFilter | 

try {
    final result = await api_instance.businessContactSearch(searchFilter);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->businessContactSearch: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        SearchFilter searchFilter = {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0}; // SearchFilter | 

        try {
            Object result = apiInstance.businessContactSearch(searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#businessContactSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
SearchFilter *searchFilter = {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0}; //  (optional)

// BusinessContact_Search
[apiInstance businessContactSearchWith:searchFilter
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AsServerApiBusinessContact = require('as_server_api_business_contact');

// Create an instance of the API class
var api = new AsServerApiBusinessContact.DefaultApi()
var opts = {
  'searchFilter': {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0} // {SearchFilter} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.businessContactSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class businessContactSearchExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var searchFilter = new SearchFilter(); // SearchFilter |  (optional) 

            try {
                // BusinessContact_Search
                Object result = apiInstance.businessContactSearch(searchFilter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.businessContactSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$searchFilter = {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0}; // SearchFilter | 

try {
    $result = $api_instance->businessContactSearch($searchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->businessContactSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $searchFilter = WWW::OPenAPIClient::Object::SearchFilter->new(); # SearchFilter | 

eval {
    my $result = $api_instance->businessContactSearch(searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->businessContactSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
searchFilter = {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0} # SearchFilter |  (optional)

try:
    # BusinessContact_Search
    api_response = api_instance.business_contact_search(searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->businessContactSearch: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let searchFilter = {"Statuses":[0],"StatusStrings":["string"],"Status":["string"],"SearchString":"string","SearchNameOnly":true,"Search":"string","StartDate":"string","EndDate":"string","DatePeriod":"string","IsExactMatch":true,"IsGetBasicInfo":true,"IncludeDeleted":true,"IncludeLogs":true,"IgnoreID":0,"ParentID":0,"GetCountOnly":true,"TransactionTypeDatTypeID":0,"CategoryID":0,"AdaptorID":0,"CategoryIDs":[0],"BrandIDs":[0],"IDs":[0],"GUIDs":["string"],"LinkedSupplierID":0,"IsApprovedForPOS":true,"IsApprovedForWeb":true,"IsApprovedForService":true,"ID":0,"IsHierarchicalSort":true,"Types":["string"],"IsShowFavourites":true,"IsHidden":true,"IncludeSystemTasks":true,"IsSystem":true,"BatchStatus":"string","SortField":"string","SortAsc":true,"GroupBy":"string","LastRowNumber":0,"MaxResults":0,"TenantID":0,"WebsiteID":0,"UserID":0}; // SearchFilter

    let mut context = DefaultApi::Context::default();
    let result = client.businessContactSearch(searchFilter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
searchFilter

Responses