Traitify

Assessments

createAssessments

Create

This method allows you to create a new assessment. A new assessment is required for each of your users. The 'id' in the response will be your unique identifier to continue this assessment at a later time, view the result, or do any matching.


/v1/assessments

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/traitify/v1/assessments?deck_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssessmentsApi;

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

public class AssessmentsApiExample {

    public static void main(String[] args) {
        
        AssessmentsApi apiInstance = new AssessmentsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String deckId = deckId_example; // String | This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero
        try {
            inline_response_200_1 result = apiInstance.createAssessments(apiecoKey, authorization, deckId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssessmentsApi#createAssessments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AssessmentsApi;

public class AssessmentsApiExample {

    public static void main(String[] args) {
        AssessmentsApi apiInstance = new AssessmentsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String deckId = deckId_example; // String | This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero
        try {
            inline_response_200_1 result = apiInstance.createAssessments(apiecoKey, authorization, deckId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssessmentsApi#createAssessments");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *deckId = deckId_example; // This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero

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

// Create
[apiInstance createAssessmentsWith:apiecoKey
    authorization:authorization
    deckId:deckId
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.AssessmentsApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var deckId = deckId_example; // {String} This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero


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

namespace Example
{
    public class createAssessmentsExample
    {
        public void main()
        {
            
            var apiInstance = new AssessmentsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var deckId = deckId_example;  // String | This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero

            try
            {
                // Create
                inline_response_200_1 result = apiInstance.createAssessments(apiecoKey, authorization, deckId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssessmentsApi.createAssessments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AssessmentsApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$deckId = deckId_example; // String | This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero

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

my $api_instance = WWW::SwaggerClient::AssessmentsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $deckId = deckId_example; # String | This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero

eval { 
    my $result = $api_instance->createAssessments(apiecoKey => $apiecoKey, authorization => $authorization, deckId => $deckId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssessmentsApi->createAssessments: $@\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.AssessmentsApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
deckId = deckId_example # String | This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website.

Example values: core, career-deck, super-hero

try: 
    # Create
    api_response = api_instance.create_assessments(apiecoKey, authorization, deckId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssessmentsApi->createAssessments: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
deck_id*
String
This indicates the type of assessment that you want to create. You can get this through the deck list resource or by going to the assessments section of this website. Example values: core, career-deck, super-hero
Required

Responses

Status: 200 - successful


Decks

listDecks

List

This method allows you to list all of our active decks. The `id` in the response is required when creating assessments.


/v1/decks

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/traitify/v1/decks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DecksApi;

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

public class DecksApiExample {

    public static void main(String[] args) {
        
        DecksApi apiInstance = new DecksApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        try {
            array[inline_response_200] result = apiInstance.listDecks(apiecoKey, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DecksApi#listDecks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DecksApi;

public class DecksApiExample {

    public static void main(String[] args) {
        DecksApi apiInstance = new DecksApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        try {
            array[inline_response_200] result = apiInstance.listDecks(apiecoKey, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DecksApi#listDecks");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x

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

// List
[apiInstance listDecksWith:apiecoKey
    authorization:authorization
              completionHandler: ^(array[inline_response_200] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.DecksApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x


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

namespace Example
{
    public class listDecksExample
    {
        public void main()
        {
            
            var apiInstance = new DecksApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x

            try
            {
                // List
                array[inline_response_200] result = apiInstance.listDecks(apiecoKey, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DecksApi.listDecks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DecksApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x

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

my $api_instance = WWW::SwaggerClient::DecksApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x

eval { 
    my $result = $api_instance->listDecks(apiecoKey => $apiecoKey, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DecksApi->listDecks: $@\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.DecksApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x

try: 
    # List
    api_response = api_instance.list_decks(apiecoKey, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DecksApi->listDecks: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required

Responses

Status: 200 - successful


Matching

specificCareerMatches

Specific Career Matches

This method will return results in the same format as Top Career Matches, but is intended for use when you have a list of O*NET Codes that you wish to get matches for rather than just getting the top matches.


/v1/assessments/{assessment_id}/matches/careers

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/traitify/v1/assessments/{assessment_id}/matches/careers?career_ids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MatchingApi;

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

public class MatchingApiExample {

    public static void main(String[] args) {
        
        MatchingApi apiInstance = new MatchingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String careerIds = careerIds_example; // String | A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00
        try {
            array[inline_response_200_4] result = apiInstance.specificCareerMatches(apiecoKey, authorization, assessmentId, careerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatchingApi#specificCareerMatches");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MatchingApi;

public class MatchingApiExample {

    public static void main(String[] args) {
        MatchingApi apiInstance = new MatchingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String careerIds = careerIds_example; // String | A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00
        try {
            array[inline_response_200_4] result = apiInstance.specificCareerMatches(apiecoKey, authorization, assessmentId, careerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatchingApi#specificCareerMatches");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *assessmentId = assessmentId_example; // 
String *careerIds = careerIds_example; // A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00

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

// Specific Career Matches
[apiInstance specificCareerMatchesWith:apiecoKey
    authorization:authorization
    assessmentId:assessmentId
    careerIds:careerIds
              completionHandler: ^(array[inline_response_200_4] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.MatchingApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var assessmentId = assessmentId_example; // {String} 

var careerIds = careerIds_example; // {String} A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00


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

namespace Example
{
    public class specificCareerMatchesExample
    {
        public void main()
        {
            
            var apiInstance = new MatchingApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var assessmentId = assessmentId_example;  // String | 
            var careerIds = careerIds_example;  // String | A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00

            try
            {
                // Specific Career Matches
                array[inline_response_200_4] result = apiInstance.specificCareerMatches(apiecoKey, authorization, assessmentId, careerIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MatchingApi.specificCareerMatches: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MatchingApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$assessmentId = assessmentId_example; // String | 
$careerIds = careerIds_example; // String | A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00

try {
    $result = $api_instance->specificCareerMatches($apiecoKey, $authorization, $assessmentId, $careerIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatchingApi->specificCareerMatches: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MatchingApi;

my $api_instance = WWW::SwaggerClient::MatchingApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $assessmentId = assessmentId_example; # String | 
my $careerIds = careerIds_example; # String | A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00

eval { 
    my $result = $api_instance->specificCareerMatches(apiecoKey => $apiecoKey, authorization => $authorization, assessmentId => $assessmentId, careerIds => $careerIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatchingApi->specificCareerMatches: $@\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.MatchingApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
assessmentId = assessmentId_example # String | 
careerIds = careerIds_example # String | A list of O*NET Codes you want to have scored against the user's personality.
Example values: 39-5094.00,25-1042.00

try: 
    # Specific Career Matches
    api_response = api_instance.specific_career_matches(apiecoKey, authorization, assessmentId, careerIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatchingApi->specificCareerMatches: %s\n" % e)

Parameters

Path parameters
Name Description
assessment_id*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
career_ids*
String
A list of O*NET Codes you want to have scored against the user's personality. Example values: 39-5094.00,25-1042.00
Required

Responses

Status: 200 - successful


topCareerMatches

Top Career Matches

This method uses Traitify's matching algorithm to match a user taking the career assessment with careers. This method will return the top matches for an assessment. You can get specific matches by passing in `careers_ids` or using the Specific Career Matches method. This can only be performed on assessments using the `career-deck` deck.


/v1/assessments/{assessment_id}/matches/careers

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/traitify/v1/assessments/{assessment_id}/matches/careers?number_of_matches=&experience_levels=&career_ids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MatchingApi;

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

public class MatchingApiExample {

    public static void main(String[] args) {
        
        MatchingApi apiInstance = new MatchingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String numberOfMatches = numberOfMatches_example; // String | This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60
        String experienceLevels = experienceLevels_example; // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
        String careerIds = careerIds_example; // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
        try {
            array[inline_response_200_4] result = apiInstance.topCareerMatches(apiecoKey, authorization, assessmentId, numberOfMatches, experienceLevels, careerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatchingApi#topCareerMatches");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MatchingApi;

public class MatchingApiExample {

    public static void main(String[] args) {
        MatchingApi apiInstance = new MatchingApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String numberOfMatches = numberOfMatches_example; // String | This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60
        String experienceLevels = experienceLevels_example; // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
        String careerIds = careerIds_example; // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
        try {
            array[inline_response_200_4] result = apiInstance.topCareerMatches(apiecoKey, authorization, assessmentId, numberOfMatches, experienceLevels, careerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MatchingApi#topCareerMatches");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *assessmentId = assessmentId_example; // 
String *numberOfMatches = numberOfMatches_example; // This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60 (optional)
String *experienceLevels = experienceLevels_example; // The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3 (optional)
String *careerIds = careerIds_example; // The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3 (optional)

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

// Top Career Matches
[apiInstance topCareerMatchesWith:apiecoKey
    authorization:authorization
    assessmentId:assessmentId
    numberOfMatches:numberOfMatches
    experienceLevels:experienceLevels
    careerIds:careerIds
              completionHandler: ^(array[inline_response_200_4] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.MatchingApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var assessmentId = assessmentId_example; // {String} 

var opts = { 
  'numberOfMatches': numberOfMatches_example, // {String} This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60
  'experienceLevels': experienceLevels_example, // {String} The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
  'careerIds': careerIds_example // {String} The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
};

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

namespace Example
{
    public class topCareerMatchesExample
    {
        public void main()
        {
            
            var apiInstance = new MatchingApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var assessmentId = assessmentId_example;  // String | 
            var numberOfMatches = numberOfMatches_example;  // String | This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60 (optional) 
            var experienceLevels = experienceLevels_example;  // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3 (optional) 
            var careerIds = careerIds_example;  // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3 (optional) 

            try
            {
                // Top Career Matches
                array[inline_response_200_4] result = apiInstance.topCareerMatches(apiecoKey, authorization, assessmentId, numberOfMatches, experienceLevels, careerIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MatchingApi.topCareerMatches: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MatchingApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$assessmentId = assessmentId_example; // String | 
$numberOfMatches = numberOfMatches_example; // String | This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60
$experienceLevels = experienceLevels_example; // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
$careerIds = careerIds_example; // String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3

try {
    $result = $api_instance->topCareerMatches($apiecoKey, $authorization, $assessmentId, $numberOfMatches, $experienceLevels, $careerIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MatchingApi->topCareerMatches: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MatchingApi;

my $api_instance = WWW::SwaggerClient::MatchingApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $assessmentId = assessmentId_example; # String | 
my $numberOfMatches = numberOfMatches_example; # String | This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60
my $experienceLevels = experienceLevels_example; # String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3
my $careerIds = careerIds_example; # String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3

eval { 
    my $result = $api_instance->topCareerMatches(apiecoKey => $apiecoKey, authorization => $authorization, assessmentId => $assessmentId, numberOfMatches => $numberOfMatches, experienceLevels => $experienceLevels, careerIds => $careerIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MatchingApi->topCareerMatches: $@\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.MatchingApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
assessmentId = assessmentId_example # String | 
numberOfMatches = numberOfMatches_example # String | This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60.
Example values: 1, 20, 4, 60 (optional)
experienceLevels = experienceLevels_example # String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3 (optional)
careerIds = careerIds_example # String | The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values.
Example values: 1,2; 4,5; 3 (optional)

try: 
    # Top Career Matches
    api_response = api_instance.top_career_matches(apiecoKey, authorization, assessmentId, numberOfMatches=numberOfMatches, experienceLevels=experienceLevels, careerIds=careerIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MatchingApi->topCareerMatches: %s\n" % e)

Parameters

Path parameters
Name Description
assessment_id*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
number_of_matches
String
This parameter allows to to specify the number of career matches you'd like returned, the default value is 20, the max value is 60. Example values: 1, 20, 4, 60
experience_levels
String
The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values. Example values: 1,2; 4,5; 3
career_ids
String
The experience levels of the careers you want returned. All careers have an experience level of 1-5 with 1 being high school/no experience and 5 being advanced degree/extensive experience. This parameter takes a list of values. Example values: 1,2; 4,5; 3

Responses

Status: 200 - successful


Results

getResults

Get

This method allows you to get all the results of a completed assessment in one resource, if the assessment hasn't been completed, the assessment slides will be returned. This endpoint takes a param that will let you choose what data is returned to you. It also allows you to specify with image_pack of the icons that are returned.


/v1developer/assessments/{assessment_id}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/traitify/v1developer/assessments/{assessment_id}?data=&image_pack="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResultsApi;

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

public class ResultsApiExample {

    public static void main(String[] args) {
        
        ResultsApi apiInstance = new ResultsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String data = data_example; // String | This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits
        String imagePack = imagePack_example; // String | This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear
        try {
            inline_response_200_3 result = apiInstance.getResults(apiecoKey, authorization, assessmentId, data, imagePack);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultsApi#getResults");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResultsApi;

public class ResultsApiExample {

    public static void main(String[] args) {
        ResultsApi apiInstance = new ResultsApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String data = data_example; // String | This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits
        String imagePack = imagePack_example; // String | This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear
        try {
            inline_response_200_3 result = apiInstance.getResults(apiecoKey, authorization, assessmentId, data, imagePack);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultsApi#getResults");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *assessmentId = assessmentId_example; // 
String *data = data_example; // This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits (optional)
String *imagePack = imagePack_example; // This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear (optional)

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

// Get
[apiInstance getResultsWith:apiecoKey
    authorization:authorization
    assessmentId:assessmentId
    data:data
    imagePack:imagePack
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.ResultsApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var assessmentId = assessmentId_example; // {String} 

var opts = { 
  'data': data_example, // {String} This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits
  'imagePack': imagePack_example // {String} This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear
};

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

namespace Example
{
    public class getResultsExample
    {
        public void main()
        {
            
            var apiInstance = new ResultsApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var assessmentId = assessmentId_example;  // String | 
            var data = data_example;  // String | This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits (optional) 
            var imagePack = imagePack_example;  // String | This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear (optional) 

            try
            {
                // Get
                inline_response_200_3 result = apiInstance.getResults(apiecoKey, authorization, assessmentId, data, imagePack);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultsApi.getResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ResultsApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$assessmentId = assessmentId_example; // String | 
$data = data_example; // String | This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits
$imagePack = imagePack_example; // String | This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear

try {
    $result = $api_instance->getResults($apiecoKey, $authorization, $assessmentId, $data, $imagePack);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResultsApi->getResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResultsApi;

my $api_instance = WWW::SwaggerClient::ResultsApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $assessmentId = assessmentId_example; # String | 
my $data = data_example; # String | This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits
my $imagePack = imagePack_example; # String | This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear

eval { 
    my $result = $api_instance->getResults(apiecoKey => $apiecoKey, authorization => $authorization, assessmentId => $assessmentId, data => $data, imagePack => $imagePack);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResultsApi->getResults: $@\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.ResultsApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
assessmentId = assessmentId_example # String | 
data = data_example # String | This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default.
Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits (optional)
imagePack = imagePack_example # String | This is the image pack you want to use for the personality type icons that are returned.
Example values: flat,linear (optional)

try: 
    # Get
    api_response = api_instance.get_results(apiecoKey, authorization, assessmentId, data=data, imagePack=imagePack)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultsApi->getResults: %s\n" % e)

Parameters

Path parameters
Name Description
assessment_id*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
data
String
This is a comma seperated list of the data that you would like returned for an assessment. The default is just to return the assessment data if the assessment is complete. If the assessment is not complete, slides will be returned by default. Example values: blend,types,traits,career_matches; blend; blend,traits; blend,career_matches; types,traits
image_pack
String
This is the image pack you want to use for the personality type icons that are returned. Example values: flat,linear

Responses

Status: 200 - successful


Slides

bulkUpdate

Bulk Update

This method allows you to update an assessment's slide responses in bulk. You pass in an array of the parameters below. There should be one array item for each slide you want to update.


/v1/assessments/{assessment_id}/slides

Usage and SDK Samples

curl -X PUT "https://api.apieco.ir/traitify/v1/assessments/{assessment_id}/slides?id=&response=&time_taken="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlidesApi;

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

public class SlidesApiExample {

    public static void main(String[] args) {
        
        SlidesApi apiInstance = new SlidesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String id = id_example; // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
        String response = response_example; // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
        String timeTaken = timeTaken_example; // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
        try {
            array[inline_response_200_2] result = apiInstance.bulkUpdate(apiecoKey, authorization, assessmentId, id, response, timeTaken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlidesApi#bulkUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlidesApi;

public class SlidesApiExample {

    public static void main(String[] args) {
        SlidesApi apiInstance = new SlidesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String id = id_example; // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
        String response = response_example; // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
        String timeTaken = timeTaken_example; // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
        try {
            array[inline_response_200_2] result = apiInstance.bulkUpdate(apiecoKey, authorization, assessmentId, id, response, timeTaken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlidesApi#bulkUpdate");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *assessmentId = assessmentId_example; // 
String *id = id_example; // The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
String *response = response_example; // The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
String *timeTaken = timeTaken_example; // The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030

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

// Bulk Update
[apiInstance bulkUpdateWith:apiecoKey
    authorization:authorization
    assessmentId:assessmentId
    id:id
    response:response
    timeTaken:timeTaken
              completionHandler: ^(array[inline_response_200_2] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.SlidesApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var assessmentId = assessmentId_example; // {String} 

var id = id_example; // {String} The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08

var response = response_example; // {String} The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false

var timeTaken = timeTaken_example; // {String} The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030


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

namespace Example
{
    public class bulkUpdateExample
    {
        public void main()
        {
            
            var apiInstance = new SlidesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var assessmentId = assessmentId_example;  // String | 
            var id = id_example;  // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
            var response = response_example;  // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
            var timeTaken = timeTaken_example;  // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030

            try
            {
                // Bulk Update
                array[inline_response_200_2] result = apiInstance.bulkUpdate(apiecoKey, authorization, assessmentId, id, response, timeTaken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlidesApi.bulkUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SlidesApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$assessmentId = assessmentId_example; // String | 
$id = id_example; // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
$response = response_example; // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
$timeTaken = timeTaken_example; // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030

try {
    $result = $api_instance->bulkUpdate($apiecoKey, $authorization, $assessmentId, $id, $response, $timeTaken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlidesApi->bulkUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlidesApi;

my $api_instance = WWW::SwaggerClient::SlidesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $assessmentId = assessmentId_example; # String | 
my $id = id_example; # String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
my $response = response_example; # String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
my $timeTaken = timeTaken_example; # String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030

eval { 
    my $result = $api_instance->bulkUpdate(apiecoKey => $apiecoKey, authorization => $authorization, assessmentId => $assessmentId, id => $id, response => $response, timeTaken => $timeTaken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlidesApi->bulkUpdate: $@\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.SlidesApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
assessmentId = assessmentId_example # String | 
id = id_example # String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
response = response_example # String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
timeTaken = timeTaken_example # String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030

try: 
    # Bulk Update
    api_response = api_instance.bulk_update(apiecoKey, authorization, assessmentId, id, response, timeTaken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlidesApi->bulkUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
assessment_id*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
id*
String
The id of the assessment slide you want to update Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
Required
response*
String
The response from the person taking the assessment; "me" == true, "not me" == false Example values: true, false
Required
time_taken*
String
The time (in milliseconds) it took for the person to respond to this slide Example values: 1500, 900, 28030
Required

Responses

Status: 200 - successful


listSlides

List

This method allows you to get a list of the slides for this assessment. It includes the path to each image for each slide and the position that the slides should be presented to the user.


/v1/assessments/{assessment_id}/slides

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/traitify/v1/assessments/{assessment_id}/slides?position=&caption=&image_="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlidesApi;

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

public class SlidesApiExample {

    public static void main(String[] args) {
        
        SlidesApi apiInstance = new SlidesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String position = position_example; // String | The order this slide should be shown to the user taking this assessment
        String caption = caption_example; // String | The caption to show with the image for this slide
        String image = image_example; // String | These are the images used for this slide
        try {
            array[inline_response_200_2] result = apiInstance.listSlides(apiecoKey, authorization, assessmentId, position, caption, image);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlidesApi#listSlides");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlidesApi;

public class SlidesApiExample {

    public static void main(String[] args) {
        SlidesApi apiInstance = new SlidesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String position = position_example; // String | The order this slide should be shown to the user taking this assessment
        String caption = caption_example; // String | The caption to show with the image for this slide
        String image = image_example; // String | These are the images used for this slide
        try {
            array[inline_response_200_2] result = apiInstance.listSlides(apiecoKey, authorization, assessmentId, position, caption, image);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlidesApi#listSlides");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *assessmentId = assessmentId_example; // 
String *position = position_example; // The order this slide should be shown to the user taking this assessment
String *caption = caption_example; // The caption to show with the image for this slide
String *image = image_example; // These are the images used for this slide

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

// List
[apiInstance listSlidesWith:apiecoKey
    authorization:authorization
    assessmentId:assessmentId
    position:position
    caption:caption
    image:image
              completionHandler: ^(array[inline_response_200_2] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.SlidesApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var assessmentId = assessmentId_example; // {String} 

var position = position_example; // {String} The order this slide should be shown to the user taking this assessment

var caption = caption_example; // {String} The caption to show with the image for this slide

var image = image_example; // {String} These are the images used for this slide


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

namespace Example
{
    public class listSlidesExample
    {
        public void main()
        {
            
            var apiInstance = new SlidesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var assessmentId = assessmentId_example;  // String | 
            var position = position_example;  // String | The order this slide should be shown to the user taking this assessment
            var caption = caption_example;  // String | The caption to show with the image for this slide
            var image = image_example;  // String | These are the images used for this slide

            try
            {
                // List
                array[inline_response_200_2] result = apiInstance.listSlides(apiecoKey, authorization, assessmentId, position, caption, image);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlidesApi.listSlides: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SlidesApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$assessmentId = assessmentId_example; // String | 
$position = position_example; // String | The order this slide should be shown to the user taking this assessment
$caption = caption_example; // String | The caption to show with the image for this slide
$image = image_example; // String | These are the images used for this slide

try {
    $result = $api_instance->listSlides($apiecoKey, $authorization, $assessmentId, $position, $caption, $image);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlidesApi->listSlides: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlidesApi;

my $api_instance = WWW::SwaggerClient::SlidesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $assessmentId = assessmentId_example; # String | 
my $position = position_example; # String | The order this slide should be shown to the user taking this assessment
my $caption = caption_example; # String | The caption to show with the image for this slide
my $image = image_example; # String | These are the images used for this slide

eval { 
    my $result = $api_instance->listSlides(apiecoKey => $apiecoKey, authorization => $authorization, assessmentId => $assessmentId, position => $position, caption => $caption, image => $image);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlidesApi->listSlides: $@\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.SlidesApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
assessmentId = assessmentId_example # String | 
position = position_example # String | The order this slide should be shown to the user taking this assessment
caption = caption_example # String | The caption to show with the image for this slide
image = image_example # String | These are the images used for this slide

try: 
    # List
    api_response = api_instance.list_slides(apiecoKey, authorization, assessmentId, position, caption, image)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlidesApi->listSlides: %s\n" % e)

Parameters

Path parameters
Name Description
assessment_id*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
position*
String
The order this slide should be shown to the user taking this assessment
Required
caption*
String
The caption to show with the image for this slide
Required
image_*
String
These are the images used for this slide
Required

Responses

Status: 200 - successful


updateSlide

Update

This method allows you to update a single slide for an assessment.


/v1/assessments/{assessment_id}/slides/{slide_id}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/traitify/v1/assessments/{assessment_id}/slides/{slide_id}?id=&response=&time_taken="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SlidesApi;

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

public class SlidesApiExample {

    public static void main(String[] args) {
        
        SlidesApi apiInstance = new SlidesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String id = id_example; // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
        String response = response_example; // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
        String timeTaken = timeTaken_example; // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
        String slideId = slideId_example; // String | 
        try {
            array[inline_response_200_2] result = apiInstance.updateSlide(apiecoKey, authorization, assessmentId, id, response, timeTaken, slideId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlidesApi#updateSlide");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SlidesApi;

public class SlidesApiExample {

    public static void main(String[] args) {
        SlidesApi apiInstance = new SlidesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String authorization = authorization_example; // String | Basic {your_public_key}:x
        String assessmentId = assessmentId_example; // String | 
        String id = id_example; // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
        String response = response_example; // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
        String timeTaken = timeTaken_example; // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
        String slideId = slideId_example; // String | 
        try {
            array[inline_response_200_2] result = apiInstance.updateSlide(apiecoKey, authorization, assessmentId, id, response, timeTaken, slideId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SlidesApi#updateSlide");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *authorization = authorization_example; // Basic {your_public_key}:x
String *assessmentId = assessmentId_example; // 
String *id = id_example; // The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
String *response = response_example; // The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
String *timeTaken = timeTaken_example; // The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
String *slideId = slideId_example; // 

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

// Update
[apiInstance updateSlideWith:apiecoKey
    authorization:authorization
    assessmentId:assessmentId
    id:id
    response:response
    timeTaken:timeTaken
    slideId:slideId
              completionHandler: ^(array[inline_response_200_2] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Traitify = require('traitify');

var api = new Traitify.SlidesApi()

var apiecoKey = apiecoKey_example; // {String} 

var authorization = authorization_example; // {String} Basic {your_public_key}:x

var assessmentId = assessmentId_example; // {String} 

var id = id_example; // {String} The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08

var response = response_example; // {String} The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false

var timeTaken = timeTaken_example; // {String} The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030

var slideId = slideId_example; // {String} 


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

namespace Example
{
    public class updateSlideExample
    {
        public void main()
        {
            
            var apiInstance = new SlidesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var authorization = authorization_example;  // String | Basic {your_public_key}:x
            var assessmentId = assessmentId_example;  // String | 
            var id = id_example;  // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
            var response = response_example;  // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
            var timeTaken = timeTaken_example;  // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
            var slideId = slideId_example;  // String | 

            try
            {
                // Update
                array[inline_response_200_2] result = apiInstance.updateSlide(apiecoKey, authorization, assessmentId, id, response, timeTaken, slideId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SlidesApi.updateSlide: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SlidesApi();
$apiecoKey = apiecoKey_example; // String | 
$authorization = authorization_example; // String | Basic {your_public_key}:x
$assessmentId = assessmentId_example; // String | 
$id = id_example; // String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
$response = response_example; // String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
$timeTaken = timeTaken_example; // String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
$slideId = slideId_example; // String | 

try {
    $result = $api_instance->updateSlide($apiecoKey, $authorization, $assessmentId, $id, $response, $timeTaken, $slideId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SlidesApi->updateSlide: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SlidesApi;

my $api_instance = WWW::SwaggerClient::SlidesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $authorization = authorization_example; # String | Basic {your_public_key}:x
my $assessmentId = assessmentId_example; # String | 
my $id = id_example; # String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
my $response = response_example; # String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
my $timeTaken = timeTaken_example; # String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
my $slideId = slideId_example; # String | 

eval { 
    my $result = $api_instance->updateSlide(apiecoKey => $apiecoKey, authorization => $authorization, assessmentId => $assessmentId, id => $id, response => $response, timeTaken => $timeTaken, slideId => $slideId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SlidesApi->updateSlide: $@\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.SlidesApi()
apiecoKey = apiecoKey_example # String | 
authorization = authorization_example # String | Basic {your_public_key}:x
assessmentId = assessmentId_example # String | 
id = id_example # String | The id of the assessment slide you want to update
Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
response = response_example # String | The response from the person taking the assessment; "me" == true, "not me" == false
Example values: true, false
timeTaken = timeTaken_example # String | The time (in milliseconds) it took for the person to respond to this slide
Example values: 1500, 900, 28030
slideId = slideId_example # String | 

try: 
    # Update
    api_response = api_instance.update_slide(apiecoKey, authorization, assessmentId, id, response, timeTaken, slideId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SlidesApi->updateSlide: %s\n" % e)

Parameters

Path parameters
Name Description
assessment_id*
String
Required
slide_id*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Authorization*
String
Basic {your_public_key}:x
Required
Query parameters
Name Description
id*
String
The id of the assessment slide you want to update Example values: 781acd1f-8184-482d-a3d1-e6190d0b7db5, 99dc6bec-b9e8-414e-97fe-2d9ee4c6be08
Required
response*
String
The response from the person taking the assessment; "me" == true, "not me" == false Example values: true, false
Required
time_taken*
String
The time (in milliseconds) it took for the person to respond to this slide Example values: 1500, 900, 28030
Required

Responses

Status: 200 - successful