Customers

API change history

Provides methods for working with customer objects and data.

Search Associates

Search for all associates that match the given search term.

Within the searchTerm parameter, the following values can be searched and will return all variable values associated with that variable name:

  • backOfficeId
  • externalId
  • emailAddress
  • firstName
  • lastName
  • legalFirstName
  • legalLastName
  • romanizedFirstName
  • romanizedLastName
  • textNumber
  • primaryPhone
  • address1
  • city
  • state
  • zip

Try it

Request

Request URL

Request parameters

  • string

    The search term used for look up.

  • (optional)
    bool

    Each response in the array will also contain an array of the customer's assigned Web Aliases.

  • (optional)
    int[]

    Filters out associates whose type id IS NOT one of the values specified. If left blank, results will not be filtered by type id. Values must be separated by a comma. Example: 1,2,3.

  • (optional)
    int[]

    Filters out associates whose status id IS NOT one of the values specified. If left blank, results will not be filtered by status id. Values must be separated by a comma. Example: 1,2,3.

  • (optional)
    string[]

    Filters out associates whose country code IS NOT one of the values specified. If left blank, results will not be filtered by country code. Values must be separated by a comma. Example: ca,us,mx.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Search items returned.

Representations

[
  {
    "AssociateType": "Distributor Associate",
    "AssociateTypeId": 1,
    "BackOfficeId": "15F92",
    "CustomerId": 2,
    "EMail": "samspace@directscaletest.com",
    "FirstName": "Sam",
    "LastName": "Space",
    "LegalFirstName": "Sam",
    "LegalLastName": "Space",
    "Phone": "654654654",
    "ProfileImageUrl": "/BackOffice/ProfileImage?id=2",
    "RomanizedFirstName": "Sam",
    "RomanizedLastName": "Space",
    "StatusId": 1,
    "TextPhone": "6546546544",
    "City": "Lindon",
    "State": "UT",
    "CountryCode": "US",
    "WebAliases": [
      "samspace",
      "samuelspace"
    ]
  }
]
{
  "type": "array",
  "items": {
    "required": [
      "AssociateType",
      "AssociateTypeId",
      "BackOfficeId",
      "CustomerId",
      "EMail",
      "FirstName",
      "LastName",
      "LegalFirstName",
      "LegalLastName",
      "Phone",
      "ProfileImageUrl",
      "RomanizedFirstName",
      "RomanizedLastName",
      "StatusId",
      "TextPhone",
      "City",
      "State",
      "CountryCode",
      "WebAliases"
    ],
    "type": "object",
    "properties": {
      "AssociateType": {
        "type": "string"
      },
      "AssociateTypeId": {
        "type": "integer"
      },
      "BackOfficeId": {
        "type": "string"
      },
      "CustomerId": {
        "type": "integer"
      },
      "EMail": {
        "type": "string"
      },
      "FirstName": {
        "type": "string"
      },
      "LastName": {
        "type": "string"
      },
      "LegalFirstName": {
        "type": "string"
      },
      "LegalLastName": {
        "type": "string"
      },
      "Phone": {
        "type": "string"
      },
      "ProfileImageUrl": {
        "type": "string"
      },
      "RomanizedFirstName": {
        "type": "string"
      },
      "RomanizedLastName": {
        "type": "string"
      },
      "StatusId": {
        "type": "integer"
      },
      "TextPhone": {
        "type": "string"
      },
      "City": {
        "type": "string"
      },
      "State": {
        "type": "string"
      },
      "CountryCode": {
        "type": "string"
      },
      "WebAliases": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "example": [
    {
      "AssociateType": "Distributor Associate",
      "AssociateTypeId": 1,
      "BackOfficeId": "15F92",
      "CustomerId": 2,
      "EMail": "samspace@directscaletest.com",
      "FirstName": "Sam",
      "LastName": "Space",
      "LegalFirstName": "Sam",
      "LegalLastName": "Space",
      "Phone": "6546546544",
      "ProfileImageUrl": "/BackOffice/ProfileImage?id=2",
      "RomanizedFirstName": "Sam",
      "RomanizedLastName": "Space",
      "StatusId": 1,
      "TextPhone": "6546546544",
      "City": "Lindon",
      "State": "UT",
      "CountryCode": "US",
      "WebAliases": [
        "samspace",
        "samuelspace"
      ]
    }
  ]
}
[
  {
    "AssociateType": "Distributor Associate",
    "AssociateTypeId": 1,
    "BackOfficeId": "15F92",
    "CustomerId": 2,
    "EMail": "samspace@directscaletest.com",
    "FirstName": "Sam",
    "LastName": "Space",
    "LegalFirstName": "Sam",
    "LegalLastName": "Space",
    "Phone": "6546546544",
    "ProfileImageUrl": "/BackOffice/ProfileImage?id=2",
    "RomanizedFirstName": "Sam",
    "RomanizedLastName": "Space",
    "StatusId": 1,
    "TextPhone": "6546546544",
    "City": "Lindon",
    "State": "UT",
    "CountryCode": "US"
  }
]
{
  "type": "array",
  "items": {
    "required": [
      "AssociateType",
      "AssociateTypeId",
      "BackOfficeId",
      "CustomerId",
      "EMail",
      "FirstName",
      "LastName",
      "LegalFirstName",
      "LegalLastName",
      "Phone",
      "ProfileImageUrl",
      "RomanizedFirstName",
      "RomanizedLastName",
      "StatusId",
      "TextPhone",
      "City",
      "State",
      "CountryCode"
    ],
    "type": "object",
    "properties": {
      "AssociateType": {
        "type": "string"
      },
      "AssociateTypeId": {
        "type": "integer"
      },
      "BackOfficeId": {
        "type": "string"
      },
      "CustomerId": {
        "type": "integer"
      },
      "EMail": {
        "type": "string"
      },
      "FirstName": {
        "type": "string"
      },
      "LastName": {
        "type": "string"
      },
      "LegalFirstName": {
        "type": "string"
      },
      "LegalLastName": {
        "type": "string"
      },
      "Phone": {
        "type": "string"
      },
      "ProfileImageUrl": {
        "type": "string"
      },
      "RomanizedFirstName": {
        "type": "string"
      },
      "RomanizedLastName": {
        "type": "string"
      },
      "StatusId": {
        "type": "integer"
      },
      "TextPhone": {
        "type": "string"
      },
      "City": {
        "type": "string"
      },
      "State": {
        "type": "string"
      },
      "CountryCode": {
        "type": "string"
      }
    }
  },
  "example": [
    {
      "AssociateType": "Distributor Associate",
      "AssociateTypeId": 1,
      "BackOfficeId": "15F92",
      "CustomerId": 2,
      "EMail": "samspace@directscaletest.com",
      "FirstName": "Sam",
      "LastName": "Space",
      "LegalFirstName": "Sam",
      "LegalLastName": "Space",
      "Phone": "6546546544",
      "ProfileImageUrl": "/BackOffice/ProfileImage?id=2",
      "RomanizedFirstName": "Sam",
      "RomanizedLastName": "Space",
      "StatusId": 1,
      "TextPhone": "6546546544",
      "City": "Lindon",
      "State": "UT",
      "CountryCode": "US"
    }
  ]
}

404 Not Found

No results found

500 Internal Server Error

Something went wrong... Here are some possible reasons for this error:

  • Is the model being sent to the API incorrect?
  • Did you forget a required field?
  • Is the API marked as deprecated, and the date has expired?

If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.

Code samples

@ECHO OFF

curl -v -X GET "https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}?includeWebAliases=false&associateTypeIds={int[]}&associateStatusIds={int[]}&countryCodes={string[]}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["includeWebAliases"] = "false";
            queryString["associateTypeIds"] = "{int[]}";
            queryString["associateStatusIds"] = "{int[]}";
            queryString["countryCodes"] = "{string[]}";
            var uri = "https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}");

            builder.setParameter("includeWebAliases", "false");
            builder.setParameter("associateTypeIds", "{int[]}");
            builder.setParameter("associateStatusIds", "{int[]}");
            builder.setParameter("countryCodes", "{string[]}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "includeWebAliases": "false",
            "associateTypeIds": "{int[]}",
            "associateStatusIds": "{int[]}",
            "countryCodes": "{string[]}",
        };
      
        $.ajax({
            url: "https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"includeWebAliases=false",
                         @"associateTypeIds={int[]}",
                         @"associateStatusIds={int[]}",
                         @"countryCodes={string[]}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'includeWebAliases' => 'false',
    'associateTypeIds' => '{int[]}',
    'associateStatusIds' => '{int[]}',
    'countryCodes' => '{string[]}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'includeWebAliases': 'false',
    'associateTypeIds': '{int[]}',
    'associateStatusIds': '{int[]}',
    'countryCodes': '{string[]}',
})

try:
    conn = httplib.HTTPSConnection('dsapi-stage.directscale.com')
    conn.request("GET", "/v1/customers/search/{searchTerm}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'includeWebAliases': 'false',
    'associateTypeIds': '{int[]}',
    'associateStatusIds': '{int[]}',
    'countryCodes': '{string[]}',
})

try:
    conn = http.client.HTTPSConnection('dsapi-stage.directscale.com')
    conn.request("GET", "/v1/customers/search/{searchTerm}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://dsapi-stage.directscale.com/v1/customers/search/{searchTerm}')

query = URI.encode_www_form({
    # Request parameters
    'includeWebAliases' => 'false',
    'associateTypeIds' => '{int[]}',
    'associateStatusIds' => '{int[]}',
    'countryCodes' => '{string[]}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body