This site is not currently optimized for a mobile device


Home > How to guide > Guide for Administrators > Integration / APIs > Candidate API Methods

Candidate API Methods

An Interrelated Set of Methods

The EasyCruit web service interface consists of a set of named methods. These methods are interrelated. This is done in such a way that the information retrieved by invoking one method may be used as input to another, related method.


There are methods to retrieve lists of projects and lists of candidates. This provides an overview over the data available. A particular project or candidate can then be selected for a full export. This retrieves all of the data associated with the item. This combination of comprehensive list and full detail ensures a customer can retrieve all of their data.


This is best made clear giving an example. There is one method called CandidateIdList, invoking which a customer may retrieve a list of candidate record identifiers. All of the data stored for a given candidate may then be retrieved by supplying the corresponding identifier to another method, called CandidateExport.

Methods Available

The exact XML format for input and output can be explored by studying the XML Schema files referenced from the WSDL file: WSDL file - You should not normally need to deal with this aspect yourself, though, as your tools should do that part of the job.

Common Authentication Parameter

Each and every method requires you to send authentication data ( defined in the SOAP HEAD) along with your specific request. No request is handled without successful authentication and authorization of the incoming request's author. This authentication data consists of customer name, user name and password. This is exactly the same kind of data that is required when logging in to the EasyCruit web application via the login form. Note, however, that in order to access the web service you need to supply the credentials of a web service user. Note that passwords cannot contain £ or €.


CandidateSearch provides you with a list of candidates within the search parameters supplied. The list contains a candidate's ID, given name, middle name, family name, date addded, date modified, date hired and which category (candidate, cv_candidate, cv_prospect, co-worker) he/she are placed in.

XSD files:

CandidateSearchRequest.xsd –

CandidateSearchResponse.xsd –


DateAddedFrom – ISO formated date YYYY-MM-DD

DateAddedTo – ISO formated date YYYY-MM-DD

DateModifiedFrom – ISO formated date YYYY-MM-DD

DateModifiedTo – ISO formated date YYYY-MM-DD

Category – String enumeration (candidate, cv_candidate, cv_prospect, co-worker)


CandidateExport returns a string that is a character entity encoded XML document. You would need to decode this and parse the XML. Further description of the XML are in Candidate.xsd

XSD files:

CandidateExportRequest.xsd –

CandidateExportResponse.xsd –

Candidate.xsd –


CandidateID – integer [required]

Language – two character iso [optional]


CandidateImport reads a character entity encoded XML document sent as a string, and adds it to the customer CV-Pool.

Further description of the XML are in Candidate.xsd

XSD files:

CandidateImportRequest.xsd –

CandidateImportResponse.xsd –

Candidate.xsd –


Candidate – string (see for details) [required]

7 / 14


Same as CandidateImport, but the candidate's ID are required in the XML document.

XSD files:

CandidateUpdateRequest.xsd –

CandidateUpdateResponse.xsd –

Candidate.xsd –


Candidate – string (see for details) [required]


XSD files:

AddCandidateToRecruitingProjectRequest –

AddCandidateToRecruitingProjectResponse –


CandidateId – integer [required]

RecruitingProjectId – integer [required]

DepartmentId – integer [required]

RecruiterId – integer [optional]


DocumentUpload could be used to attach a CV or picture to a candidate record. The file can not be larger then 2MB, and a file of type CV could only in following format:

doc, pdf, ppt, rtf, sxw, sdw, txt, text, wpd, xls, lwp, WKS, WK1, WK3, WK4, docx, xlsx, pptx, jpg, jpeg, png, tif, tiff, gif, bmp

File of type Picture could only be in following format:

jpg, jpeg, png, tif, tiff, gif, bmp

XSD files:

DocumentUploadRequest.xsd –

DocumentUplaodResponse.xsd –


CandidateId – integer [required]

DocumentType – string enumeration (cv, picture) [required]

DocumentName – string [required]

Document – string (MIME Base64 encoded version of the document) [required]


XSD files:

DocumentDownloadRequest.xsd –

DocumentDownloadResponse.xsd –


CandidateId – integer [required]

DocumentName – string [required]


CandidateValidateUsername are used to check if a username are available and properly formatted.

XSD files:

CandidateValidateUsernameRequest.xsd –

CandidateValidateUsernameResponse.xsd –


CandidateUsername – string [required]


CVSetup returns the available data fields for the specified customer, this could be used to populate

customer specific questions.

XSD files:

CVSetupRequest.xsd –

CVSetupResponse.xsd –




Events returns available events based on the specified paramaters.

XSD files:

EventsRequest.xsd –

EventsResponse.xsd –


EventModule – string [required] e.g. cv

EventClass – string [required] e.g. hired

HandledByIdentifier – string [optional] e.g. my_web_service_client

HandledByTracked – boolean [optional] keeps track of events you have sent earlier.

HandledByStatus – enumeration(all,processed,new) [optional] what to display, default are new.


using System;

class ec_soap


    public static void Main(string[] args)


        EasyCruit Service = new EasyCruit();

        Service.AuthHeaderValue = new AuthHeader();

        Service.AuthHeaderValue.Customer = "customer";

        Service.AuthHeaderValue.Username = "username";

        Service.AuthHeaderValue.Password = "password";

        /** Candidate Export **/

        MessageCandidateExport CandidateID = new MessageCandidateExport();

        CandidateID.CandidateId = "123456789";

        CandidateID.Language = "gb";

        MessageCandidateExportResponse CandidateResponse =





To compile the above example you need to download the WSDL file from EasyCruit and compile it.WSDL URL:


Command line example of compilation

wsdl EasyCruit.wsdl

mcs /target:library EasyCruit.cs r:System.Web.Services

mcs /r:EasyCruit.dll ec_soap.cs


my $service = SOAP::Lite>service('');

my $candidate = $service>CandidateExport(SOAP::Data>name('ec:CandidateId',123456789),SOAP::Data>name('ec:Language','gb'),


                                         AuthHeader => [

                                                SOAP::Data>name('Customer', 'customer'),

                                                SOAP::Data>name('Username', 'username'),

                                                SOAP::Data>name('Password', 'password')




print ($candidate gt '' ? $candidate : 'Unable to retrieve data..');


<?xml version="1.0" encoding="UTF8"?>

<soap:Envelope xmlns:xsd="" xmlns:xsi=""

xmlns:soap="" xmlns="urn:EasyCruit">















<?xml version="1.0" encoding="UTF8"?>

<soap:Envelope xmlns:soap="">


              <CandidateExportResponse xmlns="urn:EasyCruit">






The DATA for this example needs to be decoded, and the resulting XML is based on schema below:

Last modified



(not set)
(not set)
(not set)

Visma EasyCruit Support

The Community allows you to log support cases (issues) and monitor their status. If you do not have accesss to the Community, please contact your administrator or EasyCruit Support

Norwegian Community Portal Login
All Other Countries Community Portal Login

Support Contact:

Belgium (0830 - 1700):

Dutch speaking:

+31 88 23 02 380,Inward dial: 5

French speaking:

+32 28 08 25 56

Denmark (0900 - 1600 CET):

+45 88 97 97 40

For Azets customers:

+45 43 62 74 74

France (0830 - 1630 CET):

+33 1 84 88 71 86

Germany (0830 - 1630 CET):

+49 303 1199 666

Italy (0830 - 1630 CET):

+39 06 94 80 31 75

Norway (0800 - 1600 CET):

+47 23 96 33 90

Sweden (0800 - 1700 CET):

+46 (0)771-693 693, Inward dial: 2

The Netherlands (0830 - 1700):

+31 88 23 02 380,Inward dial: 5

Latvia, Lithuania and Estonia (0800 - 1700 CET):

+37 167 116 224

Finland (0800 - 1600 CET):

+358 (9) 7510 6664

UK / All Other (0830 - 1630 CET):

+44 208 068 1846