Users API

API change history

Retrieve user data such as emails, status and licensing information from the application with the Users API.

Activate user

Try it

Request

Request URL

Request parameters

  • string

    ExternalId or InternalId depends on the value in the use-external-id parameter

  • (optional)
    boolean

    Can be in the query string or header

Request headers

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

Request body

Responses

200 OK

User has been activated.

Representations

{ "Id": 123456 }

400 Bad Request

Invalid request from the client. Example: missing required parameter for GET method (which is not part of resource name, the latter will result in 404 error). 400 error should be accompanied by error code returned in the body (see format below),

Representations

[  
   {  
      "Code":1,
      "Message":"use-external-id is not provided"
   },
   {  
      "Code":2,
      "Message":"InternalId is not valid. Should be numeric value."
   },
   {  
      "Code":3,
      "Message":"Invalid data format."
   },
   {  
      "Code":4,
      "Message":"ExternalId is empty."
   },
   {  
      "Code":101,
      "Message":"Employee number already exists"
   },
   {  
      "Code":102,
      "Message":"EmployeeNumber length is not valid"
   },
   {  
      "Code":103,
      "Message":"License Violation"
   },
   {  
      "Code":104,
      "Message":"Email format is not valid"
   },
   {  
      "Code":105,
      "Message":"Email length is not valid"
   },
   {  
      "Code":106,
      "Message":"User already deleted or deactivated"
   },
   {  
      "Code":107,
      "Message":"Group does not exist or deleted"
   },
   {  
      "Code":108,
      "Message":"Not enough Licenses"
   },
   {  
      "Code":109,
      "Message":"Web MDN already exists"
   },
   {  
      "Code":110,
      "Message":"EPTT WebMDN length is not valid"
   },
   {  
      "Code":111,
      "Message":"EPTT Token length is not valid"
   },
   {  
      "Code":112,
      "Message":"EPTT Number length is not valid"
   },
   {  
      "Code":113,
      "Message":"Role is not found"
   },
   {  
      "Code":114,
      "Message":"UserName is required"
   },
   {  
      "Code":115,
      "Message":"UserName already exists"
   },
   {  
      "Code":116,
      "Message":"UserName format is not valid"
   },
   {  
      "Code":117,
      "Message":"UserName length is not valid"
   },
   {  
      "Code":118,
      "Message":"Password is require"
   },
   {  
      "Code":119,
      "Message":"Password format is not valid"
   },
   {  
      "Code":120,
      "Message":"Password length is not valid"
   },
   {  
      "Code":121,
      "Message":"FirstName length is not valid"
   },
   {  
      "Code":122,
      "Message":"LastName length is not valid"
   },
   {  
      "Code":123,
      "Message":"Phone length is not valid"
   },
   {  
      "Code":124,
      "Message":"Phone format is not valid"
   },
   {  
      "Code":125,
      "Message":"User has open orders"
   },
   {  
      "Code":126,
      "Message":"User has assigned vehicle"
   }, 
   {  
      "Code":127,
      "Message":"Account owner changing is forbidden."
   },
   {  
      "Code":128,
      "Message":"User not found or deleted."
   },
   {  
      "Code":129,
      "Message":"Vehicle was deleted or deactivated."
   },
   {  
      "Code":130,
      "Message":"Account owner cannot be 'Mobile only'."
   },
   {  
      "Code":131,
      "Message":"'Web only' user cannot be 'Mobile only'."
   },
   {  
      "Code":132,
      "Message":"Invalid license type."
   },
   {  
      "Code":133,
      "Message":"License type required."
   }
]

401 Unauthorized

Unauthorized request.

404 Not Found

User not found.

422 Unprocessable Entity

Not all methods will return code 422. Please see description of common patterns to see if 422 status code is expected (GET single item, GET lists, GET polling triggers, POST entity, PUT entity, DELETE entity, custom actions). 422 error should be accompanied by error code returned in the body (see format below).

Representations

[  
   {  
      "Code":1,
      "Message":"use-external-id is not provided"
   },
   {  
      "Code":2,
      "Message":"InternalId is not valid. Should be numeric value."
   },
   {  
      "Code":3,
      "Message":"Invalid data format."
   },
   {  
      "Code":4,
      "Message":"ExternalId is empty."
   },
   {  
      "Code":101,
      "Message":"Employee number already exists"
   },
   {  
      "Code":102,
      "Message":"EmployeeNumber length is not valid"
   },
   {  
      "Code":103,
      "Message":"License Violation"
   },
   {  
      "Code":104,
      "Message":"Email format is not valid"
   },
   {  
      "Code":105,
      "Message":"Email length is not valid"
   },
   {  
      "Code":106,
      "Message":"User already deleted or deactivated"
   },
   {  
      "Code":107,
      "Message":"Group does not exist or deleted"
   },
   {  
      "Code":108,
      "Message":"Not enough Licenses"
   },
   {  
      "Code":109,
      "Message":"Web MDN already exists"
   },
   {  
      "Code":110,
      "Message":"EPTT WebMDN length is not valid"
   },
   {  
      "Code":111,
      "Message":"EPTT Token length is not valid"
   },
   {  
      "Code":112,
      "Message":"EPTT Number length is not valid"
   },
   {  
      "Code":113,
      "Message":"Role is not found"
   },
   {  
      "Code":114,
      "Message":"UserName is required"
   },
   {  
      "Code":115,
      "Message":"UserName already exists"
   },
   {  
      "Code":116,
      "Message":"UserName format is not valid"
   },
   {  
      "Code":117,
      "Message":"UserName length is not valid"
   },
   {  
      "Code":118,
      "Message":"Password is require"
   },
   {  
      "Code":119,
      "Message":"Password format is not valid"
   },
   {  
      "Code":120,
      "Message":"Password length is not valid"
   },
   {  
      "Code":121,
      "Message":"FirstName length is not valid"
   },
   {  
      "Code":122,
      "Message":"LastName length is not valid"
   },
   {  
      "Code":123,
      "Message":"Phone length is not valid"
   },
   {  
      "Code":124,
      "Message":"Phone format is not valid"
   },
   {  
      "Code":125,
      "Message":"User has open orders"
   },
   {  
      "Code":126,
      "Message":"User has assigned vehicle"
   }, 
   {  
      "Code":127,
      "Message":"Account owner changing is forbidden."
   },
   {  
      "Code":128,
      "Message":"User not found or deleted."
   },
   {  
      "Code":129,
      "Message":"Vehicle was deleted or deactivated."
   },
   {  
      "Code":130,
      "Message":"Account owner cannot be 'Mobile only'."
   },
   {  
      "Code":131,
      "Message":"'Web only' user cannot be 'Mobile only'."
   },
   {  
      "Code":132,
      "Message":"Invalid license type."
   },
   {  
      "Code":133,
      "Message":"License type required."
   }
]

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

503 Service Unavailable

Service temporarily unavailable, because other services are temporarily unavailable (such as Azure service, required 3rd party service like Google API).

Code samples

@ECHO OFF

curl -v -X PUT "https://customerapi-encore.actsoft.com/users/v1/users/{id}/active?use-external-id={boolean}"
-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["use-external-id"] = "{boolean}";
            var uri = "https://customerapi-encore.actsoft.com/users/v1/users/{id}/active?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // 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://customerapi-encore.actsoft.com/users/v1/users/{id}/active");

            builder.setParameter("use-external-id", "{boolean}");

            URI uri = builder.build();
            HttpPut request = new HttpPut(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
            "use-external-id": "{boolean}",
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/users/v1/users/{id}/active?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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://customerapi-encore.actsoft.com/users/v1/users/{id}/active";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"use-external-id={boolean}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // 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://customerapi-encore.actsoft.com/users/v1/users/{id}/active');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'use-external-id' => '{boolean}',
);

$url->setQueryVariables($parameters);

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

// 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
    'use-external-id': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("PUT", "/users/v1/users/{id}/active?%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
    'use-external-id': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("PUT", "/users/v1/users/{id}/active?%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://customerapi-encore.actsoft.com/users/v1/users/{id}/active')

query = URI.encode_www_form({
    # Request parameters
    'use-external-id' => '{boolean}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Put.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