enableHR & HRA Cloud API

Accounts

actionStatuses

Retrieve Action Status

Returns a status of an action in an account accessible to the authenticated user.


/accounts/{accountId}/action-status/{actionStatusId}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/action-status/{actionStatusId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountsApi;

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

public class AccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        AccountsApi apiInstance = new AccountsApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an action status.
        
        try {
            ActionStatusDetail result = apiInstance.actionStatuses(accountId, actionStatusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#actionStatuses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AccountsApi;

public class AccountsApiExample {
    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an action status.
        
        try {
            ActionStatusDetail result = apiInstance.actionStatuses(accountId, actionStatusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#actionStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
AccountsApi *apiInstance = [[AccountsApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an action status. (default to null)

// Retrieve Action Status
[apiInstance actionStatusesWith:accountId
    actionStatusId:actionStatusId
              completionHandler: ^(ActionStatusDetail output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.AccountsApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an action status.

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

namespace Example
{
    public class actionStatusesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new AccountsApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an action status. (default to null)

            try {
                // Retrieve Action Status
                ActionStatusDetail result = apiInstance.actionStatuses(accountId, actionStatusId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccountsApi.actionStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccountsApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an action status.

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

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AccountsApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an action status.

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

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AccountsApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an action status. (default to null)

try: 
    # Retrieve Action Status
    api_response = api_instance.action_statuses(accountId, actionStatusId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->actionStatuses: %s\n" % e)
extern crate AccountsApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let actionStatusId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String

    let mut context = AccountsApi::Context::default();
    let result = client.actionStatuses(accountId, actionStatusId, &context).wait();

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

Scopes

read:accounts:referencedata Grant read access to reference data (branches, genders, honorifics, employment types and employment statuses)

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
actionStatusId*
String
Unique identifier of an action status.
Required

Responses


listAccounts

List Accounts

List all accounts visible to the user.


/accounts

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts?filter=&sort=&first=&after=&last=&before="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountsApi;

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

public class AccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        AccountsApi apiInstance = new AccountsApi();
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            AccountsPage result = apiInstance.listAccounts(filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#listAccounts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AccountsApi;

public class AccountsApiExample {
    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            AccountsPage result = apiInstance.listAccounts(filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#listAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
AccountsApi *apiInstance = [[AccountsApi alloc] init];
String *filter = name:Scottie*; // A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (default to null)
array[String] *sort = sort=name:asc&sort=type:desc; // WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
Integer *first = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *after = 342dfs09ds329320; // WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
Integer *last = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *before = 531dfs09ds332932; // WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

// List Accounts
[apiInstance listAccountsWith:filter
    sort:sort
    first:first
    after:after
    last:last
    before:before
              completionHandler: ^(AccountsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.AccountsApi()
var filter = name:Scottie*; // {String} A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

var opts = {
  'sort': sort=name:asc&sort=type:desc, // {array[String]} WIP Description

Specify the field, followed by asc/desc, separated by :

  'first': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'after': 342dfs09ds329320, // {String} WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'last': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'before': 531dfs09ds332932 // {String} WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

};

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

namespace Example
{
    public class listAccountsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new AccountsApi();
            var filter = name:Scottie*;  // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (default to null)
            var sort = new array[String](); // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional)  (default to null)
            var first = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var after = 342dfs09ds329320;  // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var last = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var before = 531dfs09ds332932;  // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)

            try {
                // List Accounts
                AccountsPage result = apiInstance.listAccounts(filter, sort, first, after, last, before);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccountsApi.listAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccountsApi();
$filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

$sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

$first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


try {
    $result = $api_instance->listAccounts($filter, $sort, $first, $after, $last, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->listAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AccountsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AccountsApi->new();
my $filter = name:Scottie*; # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

my $sort = [sort=name:asc&sort=type:desc]; # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

my $first = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $after = 342dfs09ds329320; # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $last = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $before = 531dfs09ds332932; # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


eval { 
    my $result = $api_instance->listAccounts(filter => $filter, sort => $sort, first => $first, after => $after, last => $last, before => $before);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->listAccounts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AccountsApi()
filter = name:Scottie* # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (default to null)
sort = sort=name:asc&sort=type:desc # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
first = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
after = 342dfs09ds329320 # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
last = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
before = 531dfs09ds332932 # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

try: 
    # List Accounts
    api_response = api_instance.list_accounts(filter, sort=sort, first=first, after=after, last=last, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->listAccounts: %s\n" % e)
extern crate AccountsApi;

pub fn main() {
    let filter = name:Scottie*; // String
    let sort = sort=name:asc&sort=type:desc; // array[String]
    let first = 100; // Integer
    let after = 342dfs09ds329320; // String
    let last = 100; // Integer
    let before = 531dfs09ds332932; // String

    let mut context = AccountsApi::Context::default();
    let result = client.listAccounts(filter, sort, first, after, last, before, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
filter*
String
A search string that contains `field:values` together with boolean operators, which can be used to filter the result. An asterix (`*`) can also be used as a wildcard for partial matches on words. Logical operators (`AND` and `OR`) can be used between terms. Terms can be grouped via parenthesis to build complex search queries (see examples below). The fields used in the field must be fields returned from the REST API endpoint. Some example filters: * `firstName:John` which would return employees whose firstName was John. * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein. * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc. * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000. * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000. * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
Required
sort
array[String]
WIP Description Specify the field, followed by asc/desc, separated by :
first
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
after
String
WIP Description Pagination: Start Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
last
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
before
String
WIP Description Pagination: End Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

Responses


retrieveCurrentAccount

Retrieves the current account

Returns information about the user authenticated with by the current JWT. **Note:** This API is subject to change, in future releases it will return a JSON object with richer account details.


/accounts/self

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/self"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountsApi;

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

public class AccountsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        AccountsApi apiInstance = new AccountsApi();
        
        try {
            CurrentAccount result = apiInstance.retrieveCurrentAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#retrieveCurrentAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AccountsApi;

public class AccountsApiExample {
    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        
        try {
            CurrentAccount result = apiInstance.retrieveCurrentAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#retrieveCurrentAccount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Retrieves the current account
[apiInstance retrieveCurrentAccountWithCompletionHandler: 
              ^(CurrentAccount output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');

// Create an instance of the API class
var api = new EnableHrHraCloudApi.AccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveCurrentAccount(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class retrieveCurrentAccountExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new AccountsApi();

            try {
                // Retrieves the current account
                CurrentAccount result = apiInstance.retrieveCurrentAccount();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccountsApi.retrieveCurrentAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccountsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AccountsApi->new();

eval { 
    my $result = $api_instance->retrieveCurrentAccount();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->retrieveCurrentAccount: $@\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.AccountsApi()

try: 
    # Retrieves the current account
    api_response = api_instance.retrieve_current_account()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->retrieveCurrentAccount: %s\n" % e)
extern crate AccountsApi;

pub fn main() {

    let mut context = AccountsApi::Context::default();
    let result = client.retrieveCurrentAccount(&context).wait();

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

Scopes

Parameters

Responses


retrieveSubscriptions

Retrieve Subscriptions for the account

Returns Subscriptions for the account.


/accounts/{accountId}/subscriptions

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountsApi;

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

public class AccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        AccountsApi apiInstance = new AccountsApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        
        try {
            Subscriptions result = apiInstance.retrieveSubscriptions(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#retrieveSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AccountsApi;

public class AccountsApiExample {
    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        
        try {
            Subscriptions result = apiInstance.retrieveSubscriptions(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#retrieveSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
AccountsApi *apiInstance = [[AccountsApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)

// Retrieve Subscriptions for the account
[apiInstance retrieveSubscriptionsWith:accountId
              completionHandler: ^(Subscriptions output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.AccountsApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.

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

namespace Example
{
    public class retrieveSubscriptionsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new AccountsApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)

            try {
                // Retrieve Subscriptions for the account
                Subscriptions result = apiInstance.retrieveSubscriptions(accountId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccountsApi.retrieveSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccountsApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.

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

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AccountsApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.

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

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AccountsApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)

try: 
    # Retrieve Subscriptions for the account
    api_response = api_instance.retrieve_subscriptions(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->retrieveSubscriptions: %s\n" % e)
extern crate AccountsApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String

    let mut context = AccountsApi::Context::default();
    let result = client.retrieveSubscriptions(accountId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required

Responses


Branches

listBranches

Lists branches

Returns an (optionally) filtered list of all branches in an account accessible to the authenticated user.


/accounts/{accountId}/branches

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/branches?filter=&sort=&first=&after=&last=&before="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BranchesApi;

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

public class BranchesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        BranchesApi apiInstance = new BranchesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            BranchesPage result = apiInstance.listBranches(accountId, filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchesApi#listBranches");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BranchesApi;

public class BranchesApiExample {
    public static void main(String[] args) {
        BranchesApi apiInstance = new BranchesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            BranchesPage result = apiInstance.listBranches(accountId, filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchesApi#listBranches");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BranchesApi *apiInstance = [[BranchesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *filter = name:Scottie*; // A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional) (default to null)
array[String] *sort = sort=name:asc&sort=type:desc; // WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
Integer *first = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *after = 342dfs09ds329320; // WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
Integer *last = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *before = 531dfs09ds332932; // WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

// Lists branches
[apiInstance listBranchesWith:accountId
    filter:filter
    sort:sort
    first:first
    after:after
    last:last
    before:before
              completionHandler: ^(BranchesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.BranchesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var opts = {
  'filter': name:Scottie*, // {String} A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

  'sort': sort=name:asc&sort=type:desc, // {array[String]} WIP Description

Specify the field, followed by asc/desc, separated by :

  'first': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'after': 342dfs09ds329320, // {String} WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'last': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'before': 531dfs09ds332932 // {String} WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

};

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

namespace Example
{
    public class listBranchesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new BranchesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var filter = name:Scottie*;  // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional)  (default to null)
            var sort = new array[String](); // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional)  (default to null)
            var first = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var after = 342dfs09ds329320;  // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var last = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var before = 531dfs09ds332932;  // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)

            try {
                // Lists branches
                BranchesPage result = apiInstance.listBranches(accountId, filter, sort, first, after, last, before);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BranchesApi.listBranches: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BranchesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

$sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

$first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


try {
    $result = $api_instance->listBranches($accountId, $filter, $sort, $first, $after, $last, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BranchesApi->listBranches: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BranchesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BranchesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $filter = name:Scottie*; # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

my $sort = [sort=name:asc&sort=type:desc]; # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

my $first = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $after = 342dfs09ds329320; # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $last = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $before = 531dfs09ds332932; # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


eval { 
    my $result = $api_instance->listBranches(accountId => $accountId, filter => $filter, sort => $sort, first => $first, after => $after, last => $last, before => $before);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BranchesApi->listBranches: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BranchesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
filter = name:Scottie* # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional) (default to null)
sort = sort=name:asc&sort=type:desc # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
first = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
after = 342dfs09ds329320 # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
last = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
before = 531dfs09ds332932 # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

try: 
    # Lists branches
    api_response = api_instance.list_branches(accountId, filter=filter, sort=sort, first=first, after=after, last=last, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BranchesApi->listBranches: %s\n" % e)
extern crate BranchesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let filter = name:Scottie*; // String
    let sort = sort=name:asc&sort=type:desc; // array[String]
    let first = 100; // Integer
    let after = 342dfs09ds329320; // String
    let last = 100; // Integer
    let before = 531dfs09ds332932; // String

    let mut context = BranchesApi::Context::default();
    let result = client.listBranches(accountId, filter, sort, first, after, last, before, &context).wait();

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

Scopes

read:accounts:referencedata Grant read access to reference data (branches, genders, honorifics, employment types and employment statuses)

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
Query parameters
Name Description
filter
String
A search string that contains `field:values` together with boolean operators, which can be used to filter the result. An asterix (`*`) can also be used as a wildcard for partial matches on words. Logical operators (`AND` and `OR`) can be used between terms. Terms can be grouped via parenthesis to build complex search queries (see examples below). The fields used in the field must be fields returned from the REST API endpoint. Some example filters: * `firstName:John` which would return employees whose firstName was John. * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein. * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc. * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000. * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000. * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
sort
array[String]
WIP Description Specify the field, followed by asc/desc, separated by :
first
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
after
String
WIP Description Pagination: Start Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
last
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
before
String
WIP Description Pagination: End Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

Responses


retrieveBranch

Retrieves a branch

Retrieves a specific branch given the `accountId` and `branchId`.


/accounts/{accountId}/branches/{branchId}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/branches/{branchId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BranchesApi;

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

public class BranchesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        BranchesApi apiInstance = new BranchesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String branchId = d5117655c5814a0fb8ee2e9ed9d6d384; // String | Unique identifier of a branch within an account.
        
        try {
            BranchDetail result = apiInstance.retrieveBranch(accountId, branchId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchesApi#retrieveBranch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BranchesApi;

public class BranchesApiExample {
    public static void main(String[] args) {
        BranchesApi apiInstance = new BranchesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String branchId = d5117655c5814a0fb8ee2e9ed9d6d384; // String | Unique identifier of a branch within an account.
        
        try {
            BranchDetail result = apiInstance.retrieveBranch(accountId, branchId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BranchesApi#retrieveBranch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
BranchesApi *apiInstance = [[BranchesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *branchId = d5117655c5814a0fb8ee2e9ed9d6d384; // Unique identifier of a branch within an account. (default to null)

// Retrieves a branch
[apiInstance retrieveBranchWith:accountId
    branchId:branchId
              completionHandler: ^(BranchDetail output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.BranchesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var branchId = d5117655c5814a0fb8ee2e9ed9d6d384; // {String} Unique identifier of a branch within an account.

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

namespace Example
{
    public class retrieveBranchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new BranchesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var branchId = d5117655c5814a0fb8ee2e9ed9d6d384;  // String | Unique identifier of a branch within an account. (default to null)

            try {
                // Retrieves a branch
                BranchDetail result = apiInstance.retrieveBranch(accountId, branchId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BranchesApi.retrieveBranch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BranchesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$branchId = d5117655c5814a0fb8ee2e9ed9d6d384; // String | Unique identifier of a branch within an account.

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

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BranchesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $branchId = d5117655c5814a0fb8ee2e9ed9d6d384; # String | Unique identifier of a branch within an account.

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

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BranchesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
branchId = d5117655c5814a0fb8ee2e9ed9d6d384 # String | Unique identifier of a branch within an account. (default to null)

try: 
    # Retrieves a branch
    api_response = api_instance.retrieve_branch(accountId, branchId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BranchesApi->retrieveBranch: %s\n" % e)
extern crate BranchesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let branchId = d5117655c5814a0fb8ee2e9ed9d6d384; // String

    let mut context = BranchesApi::Context::default();
    let result = client.retrieveBranch(accountId, branchId, &context).wait();

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

Scopes

read:accounts:referencedata Grant read access to reference data (branches, genders, honorifics, employment types and employment statuses)

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
branchId*
String
Unique identifier of a branch within an account.
Required

Responses


Candidates

convertCandidateToEmployee

Convert a candidate to employee

Converts a candidate to an employee.


/accounts/{accountId}/candidates/{candidateId}/actions/convert

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/candidates/{candidateId}/actions/convert"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;

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

public class CandidatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        CandidateConversionInputDetail candidateConversionInputDetail = ; // CandidateConversionInputDetail | 
        
        try {
            ActionStatusResponse result = apiInstance.convertCandidateToEmployee(accountId, candidateId, candidateConversionInputDetail);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#convertCandidateToEmployee");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CandidatesApi;

public class CandidatesApiExample {
    public static void main(String[] args) {
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        CandidateConversionInputDetail candidateConversionInputDetail = ; // CandidateConversionInputDetail | 
        
        try {
            ActionStatusResponse result = apiInstance.convertCandidateToEmployee(accountId, candidateId, candidateConversionInputDetail);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#convertCandidateToEmployee");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *candidateId = b48c9f492c93bc26664c1a5a4d1273; // Unique identifier of an candidate within an account. (default to null)
CandidateConversionInputDetail *candidateConversionInputDetail = ; // 

// Convert a candidate to employee
[apiInstance convertCandidateToEmployeeWith:accountId
    candidateId:candidateId
    candidateConversionInputDetail:candidateConversionInputDetail
              completionHandler: ^(ActionStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var candidateId = b48c9f492c93bc26664c1a5a4d1273; // {String} Unique identifier of an candidate within an account.
var candidateConversionInputDetail = ; // {CandidateConversionInputDetail} 

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

namespace Example
{
    public class convertCandidateToEmployeeExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CandidatesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var candidateId = b48c9f492c93bc26664c1a5a4d1273;  // String | Unique identifier of an candidate within an account. (default to null)
            var candidateConversionInputDetail = new CandidateConversionInputDetail(); // CandidateConversionInputDetail | 

            try {
                // Convert a candidate to employee
                ActionStatusResponse result = apiInstance.convertCandidateToEmployee(accountId, candidateId, candidateConversionInputDetail);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CandidatesApi.convertCandidateToEmployee: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
$candidateConversionInputDetail = ; // CandidateConversionInputDetail | 

try {
    $result = $api_instance->convertCandidateToEmployee($accountId, $candidateId, $candidateConversionInputDetail);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CandidatesApi->convertCandidateToEmployee: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CandidatesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $candidateId = b48c9f492c93bc26664c1a5a4d1273; # String | Unique identifier of an candidate within an account.
my $candidateConversionInputDetail = WWW::OPenAPIClient::Object::CandidateConversionInputDetail->new(); # CandidateConversionInputDetail | 

eval { 
    my $result = $api_instance->convertCandidateToEmployee(accountId => $accountId, candidateId => $candidateId, candidateConversionInputDetail => $candidateConversionInputDetail);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CandidatesApi->convertCandidateToEmployee: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
candidateId = b48c9f492c93bc26664c1a5a4d1273 # String | Unique identifier of an candidate within an account. (default to null)
candidateConversionInputDetail =  # CandidateConversionInputDetail | 

try: 
    # Convert a candidate to employee
    api_response = api_instance.convert_candidate_to_employee(accountId, candidateId, candidateConversionInputDetail)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CandidatesApi->convertCandidateToEmployee: %s\n" % e)
extern crate CandidatesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let candidateId = b48c9f492c93bc26664c1a5a4d1273; // String
    let candidateConversionInputDetail = ; // CandidateConversionInputDetail

    let mut context = CandidatesApi::Context::default();
    let result = client.convertCandidateToEmployee(accountId, candidateId, candidateConversionInputDetail, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
candidateId*
String
Unique identifier of an candidate within an account.
Required
Body parameters
Name Description
candidateConversionInputDetail *

Details of the candidate to be converted to an employee.

Responses


createCandidate

Creates a new candidate

Creates a new candidate. The following fields are mandatory for this request: * First Name (`firstName`) * Surname (`surname`) * Branch ID (`branchId`)


/accounts/{accountId}/candidates

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/candidates"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;

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

public class CandidatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        CandidateInputDetail candidateInputDetail = ; // CandidateInputDetail | 
        
        try {
            apiInstance.createCandidate(accountId, candidateInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#createCandidate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CandidatesApi;

public class CandidatesApiExample {
    public static void main(String[] args) {
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        CandidateInputDetail candidateInputDetail = ; // CandidateInputDetail | 
        
        try {
            apiInstance.createCandidate(accountId, candidateInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#createCandidate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
CandidateInputDetail *candidateInputDetail = ; // 

// Creates a new candidate
[apiInstance createCandidateWith:accountId
    candidateInputDetail:candidateInputDetail
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var candidateInputDetail = ; // {CandidateInputDetail} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCandidate(accountId, candidateInputDetail, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createCandidateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CandidatesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var candidateInputDetail = new CandidateInputDetail(); // CandidateInputDetail | 

            try {
                // Creates a new candidate
                apiInstance.createCandidate(accountId, candidateInputDetail);
            } catch (Exception e) {
                Debug.Print("Exception when calling CandidatesApi.createCandidate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$candidateInputDetail = ; // CandidateInputDetail | 

try {
    $api_instance->createCandidate($accountId, $candidateInputDetail);
} catch (Exception $e) {
    echo 'Exception when calling CandidatesApi->createCandidate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CandidatesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $candidateInputDetail = WWW::OPenAPIClient::Object::CandidateInputDetail->new(); # CandidateInputDetail | 

eval { 
    $api_instance->createCandidate(accountId => $accountId, candidateInputDetail => $candidateInputDetail);
};
if ($@) {
    warn "Exception when calling CandidatesApi->createCandidate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
candidateInputDetail =  # CandidateInputDetail | 

try: 
    # Creates a new candidate
    api_instance.create_candidate(accountId, candidateInputDetail)
except ApiException as e:
    print("Exception when calling CandidatesApi->createCandidate: %s\n" % e)
extern crate CandidatesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let candidateInputDetail = ; // CandidateInputDetail

    let mut context = CandidatesApi::Context::default();
    let result = client.createCandidate(accountId, candidateInputDetail, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
Body parameters
Name Description
candidateInputDetail *

Details of the candidate to be created/updated.

Responses

Name Type Format Description
Location String The location header will provide the canonical reference to the created training role.


listCandidates

Lists candidates

Returns an (optionally) filtered list of all candidates in an account accessible to the authenticated user.


/accounts/{accountId}/candidates

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/candidates?filter=&sort=&first=&after=&last=&before="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;

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

public class CandidatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            CandidatesPage result = apiInstance.listCandidates(accountId, filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#listCandidates");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CandidatesApi;

public class CandidatesApiExample {
    public static void main(String[] args) {
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            CandidatesPage result = apiInstance.listCandidates(accountId, filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#listCandidates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *filter = name:Scottie*; // A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional) (default to null)
array[String] *sort = sort=name:asc&sort=type:desc; // WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
Integer *first = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *after = 342dfs09ds329320; // WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
Integer *last = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *before = 531dfs09ds332932; // WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

// Lists candidates
[apiInstance listCandidatesWith:accountId
    filter:filter
    sort:sort
    first:first
    after:after
    last:last
    before:before
              completionHandler: ^(CandidatesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var opts = {
  'filter': name:Scottie*, // {String} A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

  'sort': sort=name:asc&sort=type:desc, // {array[String]} WIP Description

Specify the field, followed by asc/desc, separated by :

  'first': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'after': 342dfs09ds329320, // {String} WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'last': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'before': 531dfs09ds332932 // {String} WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

};

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

namespace Example
{
    public class listCandidatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CandidatesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var filter = name:Scottie*;  // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional)  (default to null)
            var sort = new array[String](); // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional)  (default to null)
            var first = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var after = 342dfs09ds329320;  // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var last = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var before = 531dfs09ds332932;  // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)

            try {
                // Lists candidates
                CandidatesPage result = apiInstance.listCandidates(accountId, filter, sort, first, after, last, before);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CandidatesApi.listCandidates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

$sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

$first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


try {
    $result = $api_instance->listCandidates($accountId, $filter, $sort, $first, $after, $last, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CandidatesApi->listCandidates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CandidatesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $filter = name:Scottie*; # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

my $sort = [sort=name:asc&sort=type:desc]; # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

my $first = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $after = 342dfs09ds329320; # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $last = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $before = 531dfs09ds332932; # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


eval { 
    my $result = $api_instance->listCandidates(accountId => $accountId, filter => $filter, sort => $sort, first => $first, after => $after, last => $last, before => $before);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CandidatesApi->listCandidates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
filter = name:Scottie* # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional) (default to null)
sort = sort=name:asc&sort=type:desc # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
first = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
after = 342dfs09ds329320 # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
last = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
before = 531dfs09ds332932 # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

try: 
    # Lists candidates
    api_response = api_instance.list_candidates(accountId, filter=filter, sort=sort, first=first, after=after, last=last, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CandidatesApi->listCandidates: %s\n" % e)
extern crate CandidatesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let filter = name:Scottie*; // String
    let sort = sort=name:asc&sort=type:desc; // array[String]
    let first = 100; // Integer
    let after = 342dfs09ds329320; // String
    let last = 100; // Integer
    let before = 531dfs09ds332932; // String

    let mut context = CandidatesApi::Context::default();
    let result = client.listCandidates(accountId, filter, sort, first, after, last, before, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
Query parameters
Name Description
filter
String
A search string that contains `field:values` together with boolean operators, which can be used to filter the result. An asterix (`*`) can also be used as a wildcard for partial matches on words. Logical operators (`AND` and `OR`) can be used between terms. Terms can be grouped via parenthesis to build complex search queries (see examples below). The fields used in the field must be fields returned from the REST API endpoint. Some example filters: * `firstName:John` which would return employees whose firstName was John. * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein. * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc. * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000. * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000. * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
sort
array[String]
WIP Description Specify the field, followed by asc/desc, separated by :
first
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
after
String
WIP Description Pagination: Start Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
last
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
before
String
WIP Description Pagination: End Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

Responses


mergeCandidates

Merges two candidates

Merges two candidates The following fields are mandatory for this request: * Candidate Id (`candidateId`)


/accounts/{accountId}/candidates/{candidateId}/actions/merge

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/candidates/{candidateId}/actions/merge"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;

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

public class CandidatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        RecordMergeInputDetail recordMergeInputDetail = ; // RecordMergeInputDetail | 
        
        try {
            ActionStatusResponse result = apiInstance.mergeCandidates(accountId, candidateId, recordMergeInputDetail);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#mergeCandidates");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CandidatesApi;

public class CandidatesApiExample {
    public static void main(String[] args) {
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        RecordMergeInputDetail recordMergeInputDetail = ; // RecordMergeInputDetail | 
        
        try {
            ActionStatusResponse result = apiInstance.mergeCandidates(accountId, candidateId, recordMergeInputDetail);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#mergeCandidates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *candidateId = b48c9f492c93bc26664c1a5a4d1273; // Unique identifier of an candidate within an account. (default to null)
RecordMergeInputDetail *recordMergeInputDetail = ; // 

// Merges two candidates
[apiInstance mergeCandidatesWith:accountId
    candidateId:candidateId
    recordMergeInputDetail:recordMergeInputDetail
              completionHandler: ^(ActionStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var candidateId = b48c9f492c93bc26664c1a5a4d1273; // {String} Unique identifier of an candidate within an account.
var recordMergeInputDetail = ; // {RecordMergeInputDetail} 

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

namespace Example
{
    public class mergeCandidatesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CandidatesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var candidateId = b48c9f492c93bc26664c1a5a4d1273;  // String | Unique identifier of an candidate within an account. (default to null)
            var recordMergeInputDetail = new RecordMergeInputDetail(); // RecordMergeInputDetail | 

            try {
                // Merges two candidates
                ActionStatusResponse result = apiInstance.mergeCandidates(accountId, candidateId, recordMergeInputDetail);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CandidatesApi.mergeCandidates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
$recordMergeInputDetail = ; // RecordMergeInputDetail | 

try {
    $result = $api_instance->mergeCandidates($accountId, $candidateId, $recordMergeInputDetail);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CandidatesApi->mergeCandidates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CandidatesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $candidateId = b48c9f492c93bc26664c1a5a4d1273; # String | Unique identifier of an candidate within an account.
my $recordMergeInputDetail = WWW::OPenAPIClient::Object::RecordMergeInputDetail->new(); # RecordMergeInputDetail | 

eval { 
    my $result = $api_instance->mergeCandidates(accountId => $accountId, candidateId => $candidateId, recordMergeInputDetail => $recordMergeInputDetail);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CandidatesApi->mergeCandidates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
candidateId = b48c9f492c93bc26664c1a5a4d1273 # String | Unique identifier of an candidate within an account. (default to null)
recordMergeInputDetail =  # RecordMergeInputDetail | 

try: 
    # Merges two candidates
    api_response = api_instance.merge_candidates(accountId, candidateId, recordMergeInputDetail)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CandidatesApi->mergeCandidates: %s\n" % e)
extern crate CandidatesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let candidateId = b48c9f492c93bc26664c1a5a4d1273; // String
    let recordMergeInputDetail = ; // RecordMergeInputDetail

    let mut context = CandidatesApi::Context::default();
    let result = client.mergeCandidates(accountId, candidateId, recordMergeInputDetail, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
candidateId*
String
Unique identifier of an candidate within an account.
Required
Body parameters
Name Description
recordMergeInputDetail *

Details of the record to be merged.

Responses


retrieveCandidate

Retrieves an candidate

Retrieves a specific candidate given the `accountId` and `candidateId`.


/accounts/{accountId}/candidates/{candidateId}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/candidates/{candidateId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;

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

public class CandidatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        
        try {
            CandidateDetail result = apiInstance.retrieveCandidate(accountId, candidateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#retrieveCandidate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CandidatesApi;

public class CandidatesApiExample {
    public static void main(String[] args) {
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        
        try {
            CandidateDetail result = apiInstance.retrieveCandidate(accountId, candidateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#retrieveCandidate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *candidateId = b48c9f492c93bc26664c1a5a4d1273; // Unique identifier of an candidate within an account. (default to null)

// Retrieves an candidate
[apiInstance retrieveCandidateWith:accountId
    candidateId:candidateId
              completionHandler: ^(CandidateDetail output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var candidateId = b48c9f492c93bc26664c1a5a4d1273; // {String} Unique identifier of an candidate within an account.

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

namespace Example
{
    public class retrieveCandidateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CandidatesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var candidateId = b48c9f492c93bc26664c1a5a4d1273;  // String | Unique identifier of an candidate within an account. (default to null)

            try {
                // Retrieves an candidate
                CandidateDetail result = apiInstance.retrieveCandidate(accountId, candidateId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CandidatesApi.retrieveCandidate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.

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

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $candidateId = b48c9f492c93bc26664c1a5a4d1273; # String | Unique identifier of an candidate within an account.

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

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
candidateId = b48c9f492c93bc26664c1a5a4d1273 # String | Unique identifier of an candidate within an account. (default to null)

try: 
    # Retrieves an candidate
    api_response = api_instance.retrieve_candidate(accountId, candidateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CandidatesApi->retrieveCandidate: %s\n" % e)
extern crate CandidatesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let candidateId = b48c9f492c93bc26664c1a5a4d1273; // String

    let mut context = CandidatesApi::Context::default();
    let result = client.retrieveCandidate(accountId, candidateId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
candidateId*
String
Unique identifier of an candidate within an account.
Required

Responses


updateCandidate

Updates a candidate

Updates a particular candidate given the `accountId` and `candidateId`. This is a complete update (the majority of fields in the body are required, or else they will be saved as null). * Changing branch IDs These will be introduced as explicit actions (as they require more information than just the status change) in a future release.


/accounts/{accountId}/candidates/{candidateId}

Usage and SDK Samples

curl -X PUT\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/candidates/{candidateId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CandidatesApi;

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

public class CandidatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        CandidateInputDetail candidateInputDetail = ; // CandidateInputDetail | 
        
        try {
            apiInstance.updateCandidate(accountId, candidateId, candidateInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#updateCandidate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CandidatesApi;

public class CandidatesApiExample {
    public static void main(String[] args) {
        CandidatesApi apiInstance = new CandidatesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
        CandidateInputDetail candidateInputDetail = ; // CandidateInputDetail | 
        
        try {
            apiInstance.updateCandidate(accountId, candidateId, candidateInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CandidatesApi#updateCandidate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CandidatesApi *apiInstance = [[CandidatesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *candidateId = b48c9f492c93bc26664c1a5a4d1273; // Unique identifier of an candidate within an account. (default to null)
CandidateInputDetail *candidateInputDetail = ; // 

// Updates a candidate
[apiInstance updateCandidateWith:accountId
    candidateId:candidateId
    candidateInputDetail:candidateInputDetail
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CandidatesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var candidateId = b48c9f492c93bc26664c1a5a4d1273; // {String} Unique identifier of an candidate within an account.
var candidateInputDetail = ; // {CandidateInputDetail} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCandidate(accountId, candidateId, candidateInputDetail, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateCandidateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CandidatesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var candidateId = b48c9f492c93bc26664c1a5a4d1273;  // String | Unique identifier of an candidate within an account. (default to null)
            var candidateInputDetail = new CandidateInputDetail(); // CandidateInputDetail | 

            try {
                // Updates a candidate
                apiInstance.updateCandidate(accountId, candidateId, candidateInputDetail);
            } catch (Exception e) {
                Debug.Print("Exception when calling CandidatesApi.updateCandidate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CandidatesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$candidateId = b48c9f492c93bc26664c1a5a4d1273; // String | Unique identifier of an candidate within an account.
$candidateInputDetail = ; // CandidateInputDetail | 

try {
    $api_instance->updateCandidate($accountId, $candidateId, $candidateInputDetail);
} catch (Exception $e) {
    echo 'Exception when calling CandidatesApi->updateCandidate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CandidatesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CandidatesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $candidateId = b48c9f492c93bc26664c1a5a4d1273; # String | Unique identifier of an candidate within an account.
my $candidateInputDetail = WWW::OPenAPIClient::Object::CandidateInputDetail->new(); # CandidateInputDetail | 

eval { 
    $api_instance->updateCandidate(accountId => $accountId, candidateId => $candidateId, candidateInputDetail => $candidateInputDetail);
};
if ($@) {
    warn "Exception when calling CandidatesApi->updateCandidate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CandidatesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
candidateId = b48c9f492c93bc26664c1a5a4d1273 # String | Unique identifier of an candidate within an account. (default to null)
candidateInputDetail =  # CandidateInputDetail | 

try: 
    # Updates a candidate
    api_instance.update_candidate(accountId, candidateId, candidateInputDetail)
except ApiException as e:
    print("Exception when calling CandidatesApi->updateCandidate: %s\n" % e)
extern crate CandidatesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let candidateId = b48c9f492c93bc26664c1a5a4d1273; // String
    let candidateInputDetail = ; // CandidateInputDetail

    let mut context = CandidatesApi::Context::default();
    let result = client.updateCandidate(accountId, candidateId, candidateInputDetail, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
candidateId*
String
Unique identifier of an candidate within an account.
Required
Body parameters
Name Description
candidateInputDetail *

Details of the candidate to be created/updated.

Responses


Competencies

createCompetency

Creates a new competency

Creates a new competency. The following fields are mandatory for this request: * Name (`name`)


/accounts/{accountId}/competencies

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/competencies"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompetenciesApi;

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

public class CompetenciesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        CompetencyInputDetail competencyInputDetail = ; // CompetencyInputDetail | 
        
        try {
            apiInstance.createCompetency(accountId, competencyInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#createCompetency");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompetenciesApi;

public class CompetenciesApiExample {
    public static void main(String[] args) {
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        CompetencyInputDetail competencyInputDetail = ; // CompetencyInputDetail | 
        
        try {
            apiInstance.createCompetency(accountId, competencyInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#createCompetency");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CompetenciesApi *apiInstance = [[CompetenciesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
CompetencyInputDetail *competencyInputDetail = ; // 

// Creates a new competency
[apiInstance createCompetencyWith:accountId
    competencyInputDetail:competencyInputDetail
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CompetenciesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var competencyInputDetail = ; // {CompetencyInputDetail} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCompetency(accountId, competencyInputDetail, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createCompetencyExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CompetenciesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var competencyInputDetail = new CompetencyInputDetail(); // CompetencyInputDetail | 

            try {
                // Creates a new competency
                apiInstance.createCompetency(accountId, competencyInputDetail);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompetenciesApi.createCompetency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompetenciesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$competencyInputDetail = ; // CompetencyInputDetail | 

try {
    $api_instance->createCompetency($accountId, $competencyInputDetail);
} catch (Exception $e) {
    echo 'Exception when calling CompetenciesApi->createCompetency: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompetenciesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompetenciesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $competencyInputDetail = WWW::OPenAPIClient::Object::CompetencyInputDetail->new(); # CompetencyInputDetail | 

eval { 
    $api_instance->createCompetency(accountId => $accountId, competencyInputDetail => $competencyInputDetail);
};
if ($@) {
    warn "Exception when calling CompetenciesApi->createCompetency: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CompetenciesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
competencyInputDetail =  # CompetencyInputDetail | 

try: 
    # Creates a new competency
    api_instance.create_competency(accountId, competencyInputDetail)
except ApiException as e:
    print("Exception when calling CompetenciesApi->createCompetency: %s\n" % e)
extern crate CompetenciesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let competencyInputDetail = ; // CompetencyInputDetail

    let mut context = CompetenciesApi::Context::default();
    let result = client.createCompetency(accountId, competencyInputDetail, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
Body parameters
Name Description
competencyInputDetail *

Details of the competency to be created.

Responses

Name Type Format Description
Location String The location header will provide the canonical reference to the created training role.


deleteCompetency

Deletes an account level competency

Deletes an account level competency. This will also involve changes to employee and other record types


/accounts/{accountId}/competencies/{competencyId}/actions/deleteCompetency

Usage and SDK Samples

curl -X POST\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/competencies/{competencyId}/actions/deleteCompetency"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompetenciesApi;

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

public class CompetenciesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
        
        try {
            ActionStatusResponse result = apiInstance.deleteCompetency(accountId, competencyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#deleteCompetency");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompetenciesApi;

public class CompetenciesApiExample {
    public static void main(String[] args) {
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
        
        try {
            ActionStatusResponse result = apiInstance.deleteCompetency(accountId, competencyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#deleteCompetency");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CompetenciesApi *apiInstance = [[CompetenciesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier (UUID) for a competency (default to null)

// Deletes an account level competency
[apiInstance deleteCompetencyWith:accountId
    competencyId:competencyId
              completionHandler: ^(ActionStatusResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CompetenciesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier (UUID) for a competency

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

namespace Example
{
    public class deleteCompetencyExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CompetenciesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier (UUID) for a competency (default to null)

            try {
                // Deletes an account level competency
                ActionStatusResponse result = apiInstance.deleteCompetency(accountId, competencyId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompetenciesApi.deleteCompetency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompetenciesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency

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

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompetenciesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier (UUID) for a competency

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

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CompetenciesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier (UUID) for a competency (default to null)

try: 
    # Deletes an account level competency
    api_response = api_instance.delete_competency(accountId, competencyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompetenciesApi->deleteCompetency: %s\n" % e)
extern crate CompetenciesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String

    let mut context = CompetenciesApi::Context::default();
    let result = client.deleteCompetency(accountId, competencyId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
competencyId*
String
Unique identifier (UUID) for a competency
Required

Responses


listCompetencies

List all the competencies for an account

Returns a list of all competencies in an account for the authenticated user.


/accounts/{accountId}/competencies

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/competencies?filter=&sort=&first=&after=&last=&before="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompetenciesApi;

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

public class CompetenciesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            CompetenciesPage result = apiInstance.listCompetencies(accountId, filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#listCompetencies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompetenciesApi;

public class CompetenciesApiExample {
    public static void main(String[] args) {
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

        array[String] sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

        Integer first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        Integer last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        String before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

        
        try {
            CompetenciesPage result = apiInstance.listCompetencies(accountId, filter, sort, first, after, last, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#listCompetencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CompetenciesApi *apiInstance = [[CompetenciesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *filter = name:Scottie*; // A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional) (default to null)
array[String] *sort = sort=name:asc&sort=type:desc; // WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
Integer *first = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *after = 342dfs09ds329320; // WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
Integer *last = 100; // WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
String *before = 531dfs09ds332932; // WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

// List all the competencies for an account
[apiInstance listCompetenciesWith:accountId
    filter:filter
    sort:sort
    first:first
    after:after
    last:last
    before:before
              completionHandler: ^(CompetenciesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CompetenciesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var opts = {
  'filter': name:Scottie*, // {String} A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

  'sort': sort=name:asc&sort=type:desc, // {array[String]} WIP Description

Specify the field, followed by asc/desc, separated by :

  'first': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'after': 342dfs09ds329320, // {String} WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'last': 100, // {Integer} WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

  'before': 531dfs09ds332932 // {String} WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

};

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

namespace Example
{
    public class listCompetenciesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CompetenciesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var filter = name:Scottie*;  // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional)  (default to null)
            var sort = new array[String](); // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional)  (default to null)
            var first = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var after = 342dfs09ds329320;  // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var last = 100;  // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)
            var before = 531dfs09ds332932;  // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional)  (default to null)

            try {
                // List all the competencies for an account
                CompetenciesPage result = apiInstance.listCompetencies(accountId, filter, sort, first, after, last, before);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompetenciesApi.listCompetencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompetenciesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$filter = name:Scottie*; // String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

$sort = sort=name:asc&sort=type:desc; // array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

$first = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$after = 342dfs09ds329320; // String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$last = 100; // Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

$before = 531dfs09ds332932; // String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


try {
    $result = $api_instance->listCompetencies($accountId, $filter, $sort, $first, $after, $last, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompetenciesApi->listCompetencies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompetenciesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompetenciesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $filter = name:Scottie*; # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.

my $sort = [sort=name:asc&sort=type:desc]; # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :

my $first = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $after = 342dfs09ds329320; # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $last = 100; # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

my $before = 531dfs09ds332932; # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.


eval { 
    my $result = $api_instance->listCompetencies(accountId => $accountId, filter => $filter, sort => $sort, first => $first, after => $after, last => $last, before => $before);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompetenciesApi->listCompetencies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CompetenciesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
filter = name:Scottie* # String | A search string that contains `field:values` together with boolean operators, which can be used to filter the result.

 An asterix (`*`) can also be used as a wildcard for partial matches on words.
 Logical operators (`AND` and `OR`) can be used between terms.
 Terms can be grouped via parenthesis to build complex search queries (see examples below).

 The fields used in the field must be fields returned from the REST API endpoint.

 Some example filters:
 * `firstName:John` which would return employees whose firstName was John.
 * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein.
 * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc.
 * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000.
 * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000.
 * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
 (optional) (default to null)
sort = sort=name:asc&sort=type:desc # array[String] | WIP Description

Specify the field, followed by asc/desc, separated by :
 (optional) (default to null)
first = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
after = 342dfs09ds329320 # String | WIP Description

Pagination: Start Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
last = 100 # Integer | WIP Description

Pagination: Indicates the number of items that would be in the results
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)
before = 531dfs09ds332932 # String | WIP Description

Pagination: End Cursor for the requested Page.
NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
 (optional) (default to null)

try: 
    # List all the competencies for an account
    api_response = api_instance.list_competencies(accountId, filter=filter, sort=sort, first=first, after=after, last=last, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompetenciesApi->listCompetencies: %s\n" % e)
extern crate CompetenciesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let filter = name:Scottie*; // String
    let sort = sort=name:asc&sort=type:desc; // array[String]
    let first = 100; // Integer
    let after = 342dfs09ds329320; // String
    let last = 100; // Integer
    let before = 531dfs09ds332932; // String

    let mut context = CompetenciesApi::Context::default();
    let result = client.listCompetencies(accountId, filter, sort, first, after, last, before, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
Query parameters
Name Description
filter
String
A search string that contains `field:values` together with boolean operators, which can be used to filter the result. An asterix (`*`) can also be used as a wildcard for partial matches on words. Logical operators (`AND` and `OR`) can be used between terms. Terms can be grouped via parenthesis to build complex search queries (see examples below). The fields used in the field must be fields returned from the REST API endpoint. Some example filters: * `firstName:John` which would return employees whose firstName was John. * `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein. * `surname:Smi*` which would return employees whose surname is Smith, Smits, Smithe, etc. * `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000. * `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000. * `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000.
sort
array[String]
WIP Description Specify the field, followed by asc/desc, separated by :
first
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
after
String
WIP Description Pagination: Start Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
last
Integer (int32)
WIP Description Pagination: Indicates the number of items that would be in the results NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
before
String
WIP Description Pagination: End Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

Responses


retrieveCompetency

Retrieve details for a competency

Retreives the details for a single competency.


/accounts/{accountId}/competencies/{competencyId}

Usage and SDK Samples

curl -X GET\
\
 -H "Accept: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/competencies/{competencyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompetenciesApi;

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

public class CompetenciesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
        
        try {
            CompetencyDetail result = apiInstance.retrieveCompetency(accountId, competencyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#retrieveCompetency");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompetenciesApi;

public class CompetenciesApiExample {
    public static void main(String[] args) {
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
        
        try {
            CompetencyDetail result = apiInstance.retrieveCompetency(accountId, competencyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#retrieveCompetency");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CompetenciesApi *apiInstance = [[CompetenciesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier (UUID) for a competency (default to null)

// Retrieve details for a competency
[apiInstance retrieveCompetencyWith:accountId
    competencyId:competencyId
              completionHandler: ^(CompetencyDetail output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CompetenciesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier (UUID) for a competency

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

namespace Example
{
    public class retrieveCompetencyExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CompetenciesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier (UUID) for a competency (default to null)

            try {
                // Retrieve details for a competency
                CompetencyDetail result = apiInstance.retrieveCompetency(accountId, competencyId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompetenciesApi.retrieveCompetency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompetenciesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency

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

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompetenciesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier (UUID) for a competency

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

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CompetenciesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier (UUID) for a competency (default to null)

try: 
    # Retrieve details for a competency
    api_response = api_instance.retrieve_competency(accountId, competencyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompetenciesApi->retrieveCompetency: %s\n" % e)
extern crate CompetenciesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String

    let mut context = CompetenciesApi::Context::default();
    let result = client.retrieveCompetency(accountId, competencyId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
competencyId*
String
Unique identifier (UUID) for a competency
Required

Responses


updateCompetency

Updates a competency

Update a specific competency given the `accountId` and `competencyId`. This is a complete update (the majority of fields in the body are required, or else they will be saved as null).


/accounts/{accountId}/competencies/{competencyId}

Usage and SDK Samples

curl -X PUT\
\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://rest.enablehr.com/accounts/{accountId}/competencies/{competencyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompetenciesApi;

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

public class CompetenciesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");
        
        // Create an instance of the API class
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
        CompetencyInputDetail competencyInputDetail = ; // CompetencyInputDetail | 
        
        try {
            apiInstance.updateCompetency(accountId, competencyId, competencyInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#updateCompetency");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompetenciesApi;

public class CompetenciesApiExample {
    public static void main(String[] args) {
        CompetenciesApi apiInstance = new CompetenciesApi();
        String accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
        String competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
        CompetencyInputDetail competencyInputDetail = ; // CompetencyInputDetail | 
        
        try {
            apiInstance.updateCompetency(accountId, competencyId, competencyInputDetail);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompetenciesApi#updateCompetency");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CompetenciesApi *apiInstance = [[CompetenciesApi alloc] init];
String *accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier of an account. (default to null)
String *competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // Unique identifier (UUID) for a competency (default to null)
CompetencyInputDetail *competencyInputDetail = ; // 

// Updates a competency
[apiInstance updateCompetencyWith:accountId
    competencyId:competencyId
    competencyInputDetail:competencyInputDetail
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var EnableHrHraCloudApi = require('enable_hr__hra_cloud_api');
var defaultClient = EnableHrHraCloudApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new EnableHrHraCloudApi.CompetenciesApi()
var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier of an account.
var competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // {String} Unique identifier (UUID) for a competency
var competencyInputDetail = ; // {CompetencyInputDetail} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCompetency(accountId, competencyId, competencyInputDetail, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateCompetencyExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new CompetenciesApi();
            var accountId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier of an account. (default to null)
            var competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d;  // String | Unique identifier (UUID) for a competency (default to null)
            var competencyInputDetail = new CompetencyInputDetail(); // CompetencyInputDetail | 

            try {
                // Updates a competency
                apiInstance.updateCompetency(accountId, competencyId, competencyInputDetail);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompetenciesApi.updateCompetency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompetenciesApi();
$accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier of an account.
$competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String | Unique identifier (UUID) for a competency
$competencyInputDetail = ; // CompetencyInputDetail | 

try {
    $api_instance->updateCompetency($accountId, $competencyId, $competencyInputDetail);
} catch (Exception $e) {
    echo 'Exception when calling CompetenciesApi->updateCompetency: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompetenciesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompetenciesApi->new();
my $accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier of an account.
my $competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; # String | Unique identifier (UUID) for a competency
my $competencyInputDetail = WWW::OPenAPIClient::Object::CompetencyInputDetail->new(); # CompetencyInputDetail | 

eval { 
    $api_instance->updateCompetency(accountId => $accountId, competencyId => $competencyId, competencyInputDetail => $competencyInputDetail);
};
if ($@) {
    warn "Exception when calling CompetenciesApi->updateCompetency: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CompetenciesApi()
accountId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier of an account. (default to null)
competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d # String | Unique identifier (UUID) for a competency (default to null)
competencyInputDetail =  # CompetencyInputDetail | 

try: 
    # Updates a competency
    api_instance.update_competency(accountId, competencyId, competencyInputDetail)
except ApiException as e:
    print("Exception when calling CompetenciesApi->updateCompetency: %s\n" % e)
extern crate CompetenciesApi;

pub fn main() {
    let accountId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let competencyId = 4eb62cb48c9f429c93bc26664c1a5a4d; // String
    let competencyInputDetail = ; // CompetencyInputDetail

    let mut context = CompetenciesApi::Context::default();
    let result = client.updateCompetency(accountId, competencyId, competencyInputDetail, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Unique identifier of an account.
Required
competencyId*
String