langxpert_logo

User

Login

Goal: Registered user can login

Description: Registered users can login using their username and password parameters. API Returns the user details with a security token (Authorization key)


/login

Usage and SDK Samples

curl -X POST "https://api.langxpert.com/api/v1/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        LoginRequest body = ; // LoginRequest | 
        try {
            apiInstance.userLogin(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        LoginRequest body = ; // LoginRequest | 
        try {
            apiInstance.userLogin(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogin");
            e.printStackTrace();
        }
    }
}
LoginRequest *body = ; // 

UserApi *apiInstance = [[UserApi alloc] init];

// Registered user can login
[apiInstance userLoginWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');

var api = new GlobalDocLangXpert.UserApi()

var body = ; // {LoginRequest} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userLogin(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class userLoginExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var body = new LoginRequest(); // LoginRequest | 

            try
            {
                // Registered user can login
                apiInstance.userLogin(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.userLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserApi();
$body = ; // LoginRequest | 

try {
    $api_instance->userLogin($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::LoginRequest->new(); # LoginRequest | 

eval { 
    $api_instance->userLogin(body => $body);
};
if ($@) {
    warn "Exception when calling UserApi->userLogin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # LoginRequest | 

try: 
    # Registered user can login
    api_instance.user_login(body)
except ApiException as e:
    print("Exception when calling UserApi->userLogin: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Login

Status: 500 - User not found


Logout

Goal: Logout

Description: Logout from the user session by sending the Auth. Token


/logout

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        try {
            apiInstance.userLogout();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        try {
            apiInstance.userLogout();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userLogout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


UserApi *apiInstance = [[UserApi alloc] init];

// Logout
[apiInstance userLogoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.UserApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userLogout(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class userLogoutExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserApi();

            try
            {
                // Logout
                apiInstance.userLogout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.userLogout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();

try {
    $api_instance->userLogout();
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userLogout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();

eval { 
    $api_instance->userLogout();
};
if ($@) {
    warn "Exception when calling UserApi->userLogout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()

try: 
    # Logout
    api_instance.user_logout()
except ApiException as e:
    print("Exception when calling UserApi->userLogout: %s\n" % e)

Parameters

Responses

Status: 200 - Logout

Status: 401 - Unauthorized: Access is denied due to an invalid or absent Authorization header.

Status: 500 - User role doesn't match with the logged in party.


Forgot Password

Goal: Get the existing password

Description: Send an email to the specified user. It includes the user login credentials.


/forgotpassword

Usage and SDK Samples

curl -X POST "https://api.langxpert.com/api/v1/forgotpassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        ForgotPasswordRequest body = ; // ForgotPasswordRequest | 
        try {
            apiInstance.forgotPassword(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#forgotPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        ForgotPasswordRequest body = ; // ForgotPasswordRequest | 
        try {
            apiInstance.forgotPassword(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#forgotPassword");
            e.printStackTrace();
        }
    }
}
ForgotPasswordRequest *body = ; // 

UserApi *apiInstance = [[UserApi alloc] init];

// Get the existing password
[apiInstance forgotPasswordWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');

var api = new GlobalDocLangXpert.UserApi()

var body = ; // {ForgotPasswordRequest} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.forgotPassword(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class forgotPasswordExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var body = new ForgotPasswordRequest(); // ForgotPasswordRequest | 

            try
            {
                // Get the existing password
                apiInstance.forgotPassword(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.forgotPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserApi();
$body = ; // ForgotPasswordRequest | 

try {
    $api_instance->forgotPassword($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->forgotPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::ForgotPasswordRequest->new(); # ForgotPasswordRequest | 

eval { 
    $api_instance->forgotPassword(body => $body);
};
if ($@) {
    warn "Exception when calling UserApi->forgotPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # ForgotPasswordRequest | 

try: 
    # Get the existing password
    api_instance.forgot_password(body)
except ApiException as e:
    print("Exception when calling UserApi->forgotPassword: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Mail Sent


Reset Password

Goal: Reset the existing password

Description: Reset the existing password with a new password


/resetpassword

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/resetpassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        ResetPasswordRequest body = ; // ResetPasswordRequest | 
        try {
            apiInstance.resetPassword(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#resetPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        ResetPasswordRequest body = ; // ResetPasswordRequest | 
        try {
            apiInstance.resetPassword(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#resetPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

ResetPasswordRequest *body = ; // 

UserApi *apiInstance = [[UserApi alloc] init];

// Reset the existing password
[apiInstance resetPasswordWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.UserApi()

var body = ; // {ResetPasswordRequest} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetPassword(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetPasswordExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserApi();
            var body = new ResetPasswordRequest(); // ResetPasswordRequest | 

            try
            {
                // Reset the existing password
                apiInstance.resetPassword(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.resetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UserApi();
$body = ; // ResetPasswordRequest | 

try {
    $api_instance->resetPassword($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->resetPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::ResetPasswordRequest->new(); # ResetPasswordRequest | 

eval { 
    $api_instance->resetPassword(body => $body);
};
if ($@) {
    warn "Exception when calling UserApi->resetPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # ResetPasswordRequest | 

try: 
    # Reset the existing password
    api_instance.reset_password(body)
except ApiException as e:
    print("Exception when calling UserApi->resetPassword: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Login

Status: 401 - Unauthorized: Access is denied due to an invalid or absent Authorization header.

Status: 500 - User role doesn't match with the logged in party.

Project

Get Languages

Goal: Get the available list of translation languages

Description: Returns the available list of translation language names with code. Example: English (United States) - USEN


/languages

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/languages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Bearer
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

ProjectApi apiInstance = new ProjectApi();
try {
    array[Language] result = apiInstance.getLanguages();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectApi#getLanguages");
    e.printStackTrace();
}
}
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

public static void main(String[] args) {
ProjectApi apiInstance = new ProjectApi();
try {
    array[Language] result = apiInstance.getLanguages();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectApi#getLanguages");
    e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Get the list of translation languages
[apiInstance getLanguagesWithCompletionHandler: 
      ^(array[Language] output, NSError* error) {
                    if (output) {
                        NSLog(@"%@", output);
                    }
                    if (error) {
                        NSLog(@"Error: %@", error);
                    }
                }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

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

namespace Example
{
public class getLanguagesExample
{
public void main()
{
    
    // Configure API key authorization: Bearer
    Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

    var apiInstance = new ProjectApi();

    try
    {
        // Get the list of translation languages
        array[Language] result = apiInstance.getLanguages();
        Debug.WriteLine(result);
    }
    catch (Exception e)
    {
        Debug.Print("Exception when calling ProjectApi.getLanguages: " + e.Message );
    }
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();

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

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();

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

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()

try: 
# Get the list of translation languages
api_response = api_instance.get_languages()
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectApi->getLanguages: %s\n" % e)

Parameters

Responses

Status: 200 - Language list

Status: 401 - Unauthorized: Access is denied due to an invalid or absent Authorization header.

Status: 500 - User role doesn't match with the logged in party.


Add Project

Goal: Add a new project

Description: Create a new project by uploading the source files and required parameters (JSON format)


/project

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/project"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ProjectApi apiInstance = new ProjectApi();
        File file = /path/to/file.txt; // File | 
        String requestJson = requestJson_example; // String | 
        try {
            apiInstance.addProject(file, requestJson);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#addProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        File file = /path/to/file.txt; // File | 
        String requestJson = requestJson_example; // String | 
        try {
            apiInstance.addProject(file, requestJson);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#addProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

File *file = /path/to/file.txt; //  (optional)
String *requestJson = requestJson_example; //  (optional)

ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Add a new project
[apiInstance addProjectWith:file
    requestJson:requestJson
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

var opts = { 
  'file': /path/to/file.txt, // {File} 
  'requestJson': requestJson_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addProject(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addProjectExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ProjectApi();
            var file = new File(); // File |  (optional) 
            var requestJson = requestJson_example;  // String |  (optional) 

            try
            {
                // Add a new project
                apiInstance.addProject(file, requestJson);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.addProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();
$file = /path/to/file.txt; // File | 
$requestJson = requestJson_example; // String | 

try {
    $api_instance->addProject($file, $requestJson);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->addProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $file = /path/to/file.txt; # File | 
my $requestJson = requestJson_example; # String | 

eval { 
    $api_instance->addProject(file => $file, requestJson => $requestJson);
};
if ($@) {
    warn "Exception when calling ProjectApi->addProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
file = /path/to/file.txt # File |  (optional)
requestJson = requestJson_example # String |  (optional)

try: 
    # Add a new project
    api_instance.add_project(file=file, requestJson=requestJson)
except ApiException as e:
    print("Exception when calling ProjectApi->addProject: %s\n" % e)

Parameters

Form parameters
Name Description
file
File
requestJson
'{"projectName":"string","clientProjCode":"string","companyId":"string","desc":"string","quoteOrder":"string","endTS":"string","translationType":"string","projectType":"string","targetLangList":[{"sourceLang":"string","targetLang":"string","validatorPartyId":"string","targetLangTS":"2022-05-12T12:00:32.135Z","remark":"string"}],"contentType":"string","subject":"string","body":"string","checkMail":"string","directorPartyId":"string","poNum":"string"}'

Responses

Status: 200 - Returns created project details


Status: 405 - Invalid input


Update Project

Goal: Update an existing project

Description: Update an existing project by modifying the values.


/project

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/project"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ProjectApi apiInstance = new ProjectApi();
        File file = /path/to/file.txt; // File | 
        String requestJson = requestJson_example; // String | 
        try {
            apiInstance.updateProject(file, requestJson);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        File file = /path/to/file.txt; // File | 
        String requestJson = requestJson_example; // String | 
        try {
            apiInstance.updateProject(file, requestJson);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

File *file = /path/to/file.txt; //  (optional)
String *requestJson = requestJson_example; //  (optional)

ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Update an existing project
[apiInstance updateProjectWith:file
    requestJson:requestJson
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

var opts = { 
  'file': /path/to/file.txt, // {File} 
  'requestJson': requestJson_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProject(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ProjectApi();
            var file = new File(); // File |  (optional) 
            var requestJson = requestJson_example;  // String |  (optional) 

            try
            {
                // Update an existing project
                apiInstance.updateProject(file, requestJson);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();
$file = /path/to/file.txt; // File | 
$requestJson = requestJson_example; // String | 

try {
    $api_instance->updateProject($file, $requestJson);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $file = /path/to/file.txt; # File | 
my $requestJson = requestJson_example; # String | 

eval { 
    $api_instance->updateProject(file => $file, requestJson => $requestJson);
};
if ($@) {
    warn "Exception when calling ProjectApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
file = /path/to/file.txt # File |  (optional)
requestJson = requestJson_example # String |  (optional)

try: 
    # Update an existing project
    api_instance.update_project(file=file, requestJson=requestJson)
except ApiException as e:
    print("Exception when calling ProjectApi->updateProject: %s\n" % e)

Parameters

Form parameters
Name Description
file
File
requestJson
'{"projectName":"string","clientProjCode":"string","companyId":"string","desc":"string","quoteOrder":"string","endTS":"string","translationType":"string","projectType":"string","targetLangList":[{"sourceLang":"string","targetLang":"string","validatorPartyId":"string","targetLangTS":"2022-05-12T12:00:32.135Z","remark":"string"}],"contentType":"string","subject":"string","body":"string","checkMail":"string","directorPartyId":"string","poNum":"string"}'

Responses

Status: 400 - Invalid ID supplied

Status: 404 - Project not found

Status: 405 - Validation exception


Find Project By ID

Goal: Find Project by ID

Description: Return the project detail by project ID


/project/{projectWorkEffortId}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/project/{projectWorkEffortId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ProjectApi apiInstance = new ProjectApi();
        String projectWorkEffortId = projectWorkEffortId_example; // String | Tags to filter by
        try {
            array[Project] result = apiInstance.findProjectsByID(projectWorkEffortId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#findProjectsByID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectWorkEffortId = projectWorkEffortId_example; // String | Tags to filter by
        try {
            array[Project] result = apiInstance.findProjectsByID(projectWorkEffortId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#findProjectsByID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *projectWorkEffortId = projectWorkEffortId_example; // Tags to filter by

ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Find Project by ID
[apiInstance findProjectsByIDWith:projectWorkEffortId
              completionHandler: ^(array[Project] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

var projectWorkEffortId = projectWorkEffortId_example; // {String} Tags to filter by


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

namespace Example
{
    public class findProjectsByIDExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ProjectApi();
            var projectWorkEffortId = projectWorkEffortId_example;  // String | Tags to filter by

            try
            {
                // Find Project by ID
                array[Project] result = apiInstance.findProjectsByID(projectWorkEffortId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.findProjectsByID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();
$projectWorkEffortId = projectWorkEffortId_example; // String | Tags to filter by

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

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $projectWorkEffortId = projectWorkEffortId_example; # String | Tags to filter by

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

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
projectWorkEffortId = projectWorkEffortId_example # String | Tags to filter by

try: 
    # Find Project by ID
    api_response = api_instance.find_projects_by_id(projectWorkEffortId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->findProjectsByID: %s\n" % e)

Parameters

Path parameters
Name Description
projectWorkEffortId*
String
Tags to filter by
Required

Responses

Status: 200 - Returns Project Details

Status: 400 - Invalid tag value


Find Projects By Status

Goal: Find all the projects

Description: Return all the active projects based on the user login


/projects

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ProjectApi apiInstance = new ProjectApi();
        FilterProjectsBody body = ; // FilterProjectsBody | Status values that need to be considered for filter
        try {
            array[Project] result = apiInstance.findProjectsByStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#findProjectsByStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        FilterProjectsBody body = ; // FilterProjectsBody | Status values that need to be considered for filter
        try {
            array[Project] result = apiInstance.findProjectsByStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#findProjectsByStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

FilterProjectsBody *body = ; // Status values that need to be considered for filter (optional)

ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Find all the projects
[apiInstance findProjectsByStatusWith:body
              completionHandler: ^(array[Project] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

var opts = { 
  'body':  // {FilterProjectsBody} Status values that need to be considered for filter
};

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

namespace Example
{
    public class findProjectsByStatusExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ProjectApi();
            var body = new FilterProjectsBody(); // FilterProjectsBody | Status values that need to be considered for filter (optional) 

            try
            {
                // Find all the projects
                array[Project] result = apiInstance.findProjectsByStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.findProjectsByStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();
$body = ; // FilterProjectsBody | Status values that need to be considered for filter

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

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::FilterProjectsBody->new(); # FilterProjectsBody | Status values that need to be considered for filter

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

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # FilterProjectsBody | Status values that need to be considered for filter (optional)

try: 
    # Find all the projects
    api_response = api_instance.find_projects_by_status(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->findProjectsByStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Returns the list of projects match with the request status

Status: 400 - Invalid status value


Project Action

Goal: Project action will update the status based on the action

Description: Project action will update the status based on the action. ex: if the user action equal to (click on) Send Mail button, approve tab, decline project, hold, Update PO, Accept Deliverable and Ask Question


Action Types:

  1. ACCEPT_DELIVERABLE
  2. DECLINE
  3. HOLDREQUOTE
  4. APPROVE
  5. CANCEL

/project/action

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/project/action"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Bearer
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

ProjectApi apiInstance = new ProjectApi();
File file = /path/to/file.txt; // File | 
String requestJson = requestJson_example; // String | 
try {
    apiInstance.projectAction(file, requestJson);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectApi#projectAction");
    e.printStackTrace();
}
}
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

public static void main(String[] args) {
ProjectApi apiInstance = new ProjectApi();
File file = /path/to/file.txt; // File | 
String requestJson = requestJson_example; // String | 
try {
    apiInstance.projectAction(file, requestJson);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectApi#projectAction");
    e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

File *file = /path/to/file.txt; //  (optional)
String *requestJson = requestJson_example; //  (optional)

ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Find Projects by Text Search
[apiInstance projectActionWith:file
requestJson:requestJson
      completionHandler: ^(NSError* error) {
                    if (error) {
                        NSLog(@"Error: %@", error);
                    }
                }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

var opts = { 
'file': /path/to/file.txt, // {File} 
'requestJson': requestJson_example // {String} 
};

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.projectAction(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class projectActionExample
{
public void main()
{
    
    // Configure API key authorization: Bearer
    Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

    var apiInstance = new ProjectApi();
    var file = new File(); // File |  (optional) 
    var requestJson = requestJson_example;  // String |  (optional) 

    try
    {
        // Find Projects by Text Search
        apiInstance.projectAction(file, requestJson);
    }
    catch (Exception e)
    {
        Debug.Print("Exception when calling ProjectApi.projectAction: " + e.Message );
    }
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();
$file = /path/to/file.txt; // File | 
$requestJson = requestJson_example; // String | 

try {
$api_instance->projectAction($file, $requestJson);
} catch (Exception $e) {
echo 'Exception when calling ProjectApi->projectAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $file = /path/to/file.txt; # File | 
my $requestJson = requestJson_example; # String | 

eval { 
$api_instance->projectAction(file => $file, requestJson => $requestJson);
};
if ($@) {
warn "Exception when calling ProjectApi->projectAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
file = /path/to/file.txt # File |  (optional)
requestJson = requestJson_example # String |  (optional)

try: 
# Find Projects by Text Search
api_instance.project_action(file=file, requestJson=requestJson)
except ApiException as e:
print("Exception when calling ProjectApi->projectAction: %s\n" % e)

Parameters

Form parameters
Name Description
file
File
requestJson
'{"projectId":"string","poNum":"string","action":"string","statusId":"string","subject":"string","body":"string"}'

Responses

Status: 200 - Action submitted successfully

Status: 400 - Invalid ID supplied

Status: 404 - Project not found

Validate Project

Goal: Validate Project Name

Description: Check If the project name is already exists or not in DB and return the response back to UI


/project/validate

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/project/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Bearer
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

ProjectApi apiInstance = new ProjectApi();
ProjectValidateBody body = ; // ProjectValidateBody | 
try {
    apiInstance.validateProject(body);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectApi#validateProject");
    e.printStackTrace();
}
}
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

public static void main(String[] args) {
ProjectApi apiInstance = new ProjectApi();
ProjectValidateBody body = ; // ProjectValidateBody | 
try {
    apiInstance.validateProject(body);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectApi#validateProject");
    e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

ProjectValidateBody *body = ; // 

ProjectApi *apiInstance = [[ProjectApi alloc] init];

// Validate Project Name
[apiInstance validateProjectWith:body
      completionHandler: ^(NSError* error) {
                    if (error) {
                        NSLog(@"Error: %@", error);
                    }
                }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.ProjectApi()

var body = ; // {ProjectValidateBody} 


var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.validateProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class validateProjectExample
{
public void main()
{
    
    // Configure API key authorization: Bearer
    Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

    var apiInstance = new ProjectApi();
    var body = new ProjectValidateBody(); // ProjectValidateBody | 

    try
    {
        // Validate Project Name
        apiInstance.validateProject(body);
    }
    catch (Exception e)
    {
        Debug.Print("Exception when calling ProjectApi.validateProject: " + e.Message );
    }
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ProjectApi();
$body = ; // ProjectValidateBody | 

try {
$api_instance->validateProject($body);
} catch (Exception $e) {
echo 'Exception when calling ProjectApi->validateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::ProjectValidateBody->new(); # ProjectValidateBody | 

eval { 
$api_instance->validateProject(body => $body);
};
if ($@) {
warn "Exception when calling ProjectApi->validateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # ProjectValidateBody | 

try: 
# Validate Project Name
api_instance.validate_project(body)
except ApiException as e:
print("Exception when calling ProjectApi->validateProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Requested Id doesn't exists

Status: 400 - Project Name already exists

Status: 401 - Unauthorized: Access is denied due to invalid or absent Authorization header.

Status: 500 - User role doesn't match with the logged in party.

Task

Get Task Detail By ID

Goal: Get the task details by user role and task ID

Description: Return the project task based on the user role (VALIDATOR, TRANSLATOR and DTP-COORDINATOR) and task ID


/task/{roleTypeId}/{taskWorkEffortId}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/task/{roleTypeId}/{taskWorkEffortId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

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

public class TaskApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        TaskApi apiInstance = new TaskApi();
        String roleTypeId = roleTypeId_example; // String | User Role
        String taskWorkEffortId = taskWorkEffortId_example; // String | Task ID
        try {
            apiInstance.getTaskDetailByID(roleTypeId, taskWorkEffortId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#getTaskDetailByID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        String roleTypeId = roleTypeId_example; // String | User Role
        String taskWorkEffortId = taskWorkEffortId_example; // String | Task ID
        try {
            apiInstance.getTaskDetailByID(roleTypeId, taskWorkEffortId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#getTaskDetailByID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *roleTypeId = roleTypeId_example; // User Role
String *taskWorkEffortId = taskWorkEffortId_example; // Task ID

TaskApi *apiInstance = [[TaskApi alloc] init];

// Get the task details by user role and task ID
[apiInstance getTaskDetailByIDWith:roleTypeId
    taskWorkEffortId:taskWorkEffortId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.TaskApi()

var roleTypeId = roleTypeId_example; // {String} User Role

var taskWorkEffortId = taskWorkEffortId_example; // {String} Task ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTaskDetailByID(roleTypeId, taskWorkEffortId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTaskDetailByIDExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TaskApi();
            var roleTypeId = roleTypeId_example;  // String | User Role
            var taskWorkEffortId = taskWorkEffortId_example;  // String | Task ID

            try
            {
                // Get the task details by user role and task ID
                apiInstance.getTaskDetailByID(roleTypeId, taskWorkEffortId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.getTaskDetailByID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TaskApi();
$roleTypeId = roleTypeId_example; // String | User Role
$taskWorkEffortId = taskWorkEffortId_example; // String | Task ID

try {
    $api_instance->getTaskDetailByID($roleTypeId, $taskWorkEffortId);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->getTaskDetailByID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $roleTypeId = roleTypeId_example; # String | User Role
my $taskWorkEffortId = taskWorkEffortId_example; # String | Task ID

eval { 
    $api_instance->getTaskDetailByID(roleTypeId => $roleTypeId, taskWorkEffortId => $taskWorkEffortId);
};
if ($@) {
    warn "Exception when calling TaskApi->getTaskDetailByID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TaskApi()
roleTypeId = roleTypeId_example # String | User Role
taskWorkEffortId = taskWorkEffortId_example # String | Task ID

try: 
    # Get the task details by user role and task ID
    api_instance.get_task_detail_by_id(roleTypeId, taskWorkEffortId)
except ApiException as e:
    print("Exception when calling TaskApi->getTaskDetailByID: %s\n" % e)

Parameters

Path parameters
Name Description
roleTypeId*
String (capital)
User Role
Required
taskWorkEffortId*
String (string)
Task ID
Required

Responses

Status: 200 - task detail

Status: 401 - Unauthorized: Access is denied due to an invalid or absent Authorization header.

Status: 500 - User role doesn't match with the logged in party.


Get Task Details List

Goal: Get all the tasks by user role

Description: Return all the project tasks based on the user role such as VALIDATOR, TRANSLATOR and DTP-COORDINATOR


/tasks/{roleTypeId}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/tasks/{roleTypeId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

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

public class TaskApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        TaskApi apiInstance = new TaskApi();
        String roleTypeId = roleTypeId_example; // String | User Role
        FilterTasksBody body = ; // FilterTasksBody | 
        try {
            apiInstance.getTaskDetailsList(roleTypeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#getTaskDetailsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        String roleTypeId = roleTypeId_example; // String | User Role
        FilterTasksBody body = ; // FilterTasksBody | 
        try {
            apiInstance.getTaskDetailsList(roleTypeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#getTaskDetailsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *roleTypeId = roleTypeId_example; // User Role
FilterTasksBody *body = ; //  (optional)

TaskApi *apiInstance = [[TaskApi alloc] init];

// Get all the tasks by user role
[apiInstance getTaskDetailsListWith:roleTypeId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.TaskApi()

var roleTypeId = roleTypeId_example; // {String} User Role

var opts = { 
  'body':  // {FilterTasksBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTaskDetailsList(roleTypeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTaskDetailsListExample
    {
        public void main()
        {
            
            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TaskApi();
            var roleTypeId = roleTypeId_example;  // String | User Role
            var body = new FilterTasksBody(); // FilterTasksBody |  (optional) 

            try
            {
                // Get all the tasks by user role
                apiInstance.getTaskDetailsList(roleTypeId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.getTaskDetailsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TaskApi();
$roleTypeId = roleTypeId_example; // String | User Role
$body = ; // FilterTasksBody | 

try {
    $api_instance->getTaskDetailsList($roleTypeId, $body);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->getTaskDetailsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $roleTypeId = roleTypeId_example; # String | User Role
my $body = WWW::SwaggerClient::Object::FilterTasksBody->new(); # FilterTasksBody | 

eval { 
    $api_instance->getTaskDetailsList(roleTypeId => $roleTypeId, body => $body);
};
if ($@) {
    warn "Exception when calling TaskApi->getTaskDetailsList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TaskApi()
roleTypeId = roleTypeId_example # String | User Role
body =  # FilterTasksBody |  (optional)

try: 
    # Get all the tasks by user role
    api_instance.get_task_details_list(roleTypeId, body=body)
except ApiException as e:
    print("Exception when calling TaskApi->getTaskDetailsList: %s\n" % e)

Parameters

Path parameters
Name Description
roleTypeId*
String (capital)
User Role
Required
Body parameters
Name Description
body

Responses

Status: 200 - Tasks Lists

Status: 401 - Unauthorized: Access is denied due to an invalid or absent Authorization header.

Status: 500 - User role doesn't match with the logged in party.


Task Action

Goal: Task action will update the status based on the action

Description: Task action will update the status based on the action. ex: if the user action is equal to (click on) Finish or Edits Submit Button


Action Types:

  1. FINISH
  2. EDITS_SUBMIT


User Roles:

  1. TRANSLATOR
  2. VALIDATOR
  3. DTP_COORDINATOR


/task/action/{userRole}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://api.langxpert.com/api/v1/task/action/{userRole}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

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

public class TaskApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Bearer
ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
Bearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.setApiKeyPrefix("Token");

TaskApi apiInstance = new TaskApi();
String userRole = userRole_example; // String | User Role
File file = /path/to/file.txt; // File | 
String requestJson = requestJson_example; // String | 
try {
    apiInstance.taskAction(userRole, file, requestJson);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskApi#taskAction");
    e.printStackTrace();
}
}
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

public static void main(String[] args) {
TaskApi apiInstance = new TaskApi();
String userRole = userRole_example; // String | User Role
File file = /path/to/file.txt; // File | 
String requestJson = requestJson_example; // String | 
try {
    apiInstance.taskAction(userRole, file, requestJson);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskApi#taskAction");
    e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *userRole = userRole_example; // User Role
File *file = /path/to/file.txt; //  (optional)
String *requestJson = requestJson_example; //  (optional)

TaskApi *apiInstance = [[TaskApi alloc] init];

// Task action will update the status based on the action
[apiInstance taskActionWith:userRole
file:file
requestJson:requestJson
      completionHandler: ^(NSError* error) {
                    if (error) {
                        NSLog(@"Error: %@", error);
                    }
                }];
var GlobalDocLangXpert = require('global_doc_lang_xpert');
var defaultClient = GlobalDocLangXpert.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new GlobalDocLangXpert.TaskApi()

var userRole = userRole_example; // {String} User Role

var opts = { 
'file': /path/to/file.txt, // {File} 
'requestJson': requestJson_example // {String} 
};

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.taskAction(userRole, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
public class taskActionExample
{
public void main()
{
    
    // Configure API key authorization: Bearer
    Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

    var apiInstance = new TaskApi();
    var userRole = userRole_example;  // String | User Role
    var file = new File(); // File |  (optional) 
    var requestJson = requestJson_example;  // String |  (optional) 

    try
    {
        // Task action will update the status based on the action
        apiInstance.taskAction(userRole, file, requestJson);
    }
    catch (Exception e)
    {
        Debug.Print("Exception when calling TaskApi.taskAction: " + e.Message );
    }
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TaskApi();
$userRole = userRole_example; // String | User Role
$file = /path/to/file.txt; // File | 
$requestJson = requestJson_example; // String | 

try {
$api_instance->taskAction($userRole, $file, $requestJson);
} catch (Exception $e) {
echo 'Exception when calling TaskApi->taskAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $userRole = userRole_example; # String | User Role
my $file = /path/to/file.txt; # File | 
my $requestJson = requestJson_example; # String | 

eval { 
$api_instance->taskAction(userRole => $userRole, file => $file, requestJson => $requestJson);
};
if ($@) {
warn "Exception when calling TaskApi->taskAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TaskApi()
userRole = userRole_example # String | User Role
file = /path/to/file.txt # File |  (optional)
requestJson = requestJson_example # String |  (optional)

try: 
# Task action will update the status based on the action
api_instance.task_action(userRole, file=file, requestJson=requestJson)
except ApiException as e:
print("Exception when calling TaskApi->taskAction: %s\n" % e)

Parameters

Path parameters
Name Description
userRole*
String (string)
User Role
Required
Form parameters
Name Description
file
File
requestJson
'{"projectId":"string","poNum":"string","action":"string","statusId":"string","subject":"string","body":"string"}'

Responses

Status: 200 - Action submitted successfully

Status: 400 - Invalid ID supplied

Status: 404 - Task not found