SOAP import

SOAP is a unidirectional read-only interface that supports the import of user or master data into Umantis.

Data import via SOAP

All of the data described below for Employee Management, as well as users for Applicant Manage-ment, can also be imported into Umantis through a SOAP interface. SOAP is one way of performing imports, and is used to transfer XML-based data or Excel (via SOAP).

The SOAP import can only be used with files in the UTF-8 encoding.

URL (SOAP endpoint)

For the Swiss hosting center: https://soap.umantis.com/umantis.WebImport.Stable/HttpImport.asmx

For the German hosting center: https://soap.de.umantis.com/umantis.WebImport.Stable/HttpImport.asmx

For customers that handle their own hosting (standalone), the URL may have a com-pletely different structure.

Notes / Requirements for standalone installations

The web server’s SSL certificate must specify the exact name of the solution.

Request SOAP fields

• ApplicationUri: {your application’s address}/Public/Import/HTTPInterface<ApplicationUri>

Example for Applicant Management (Switzerland): https://recruitingapp-ID.umantis.com/Public/Import/HTTPInterface

Example for Employee Management (Germany): https://employeeapp-ID.de.umantis.com/Public/Import/HTTPInterface

• AuthenticationKey (string): The authentication key configured in the solution under Settings for automatic imports: <AuthenticationKey>
• ImportType (string): type of file to be imported (available import types are listed below): <Im-portType>
• File (byte array) — binary file content as a byte array <File> (according to the following example structure: XML import/export structure)
• Filename (string): name of the file to be imported (displayed in the solution): <Filename>
  CAUTION: The file extension must be correctly indicated, e.g. “my_import.xml”; entering “my_import” only would not work.

Optional fields:

• Title (string): Import title: <Title>
• SendStatusMail (boolean): If you enter “true” here, an email will be sent to the email address set up in the solution after the import is completed; if you enter “false”, no e-mail will be sent. <SendStatus-Mail>
• Comments (string): Comments on the import: <Comments>

If there are additional documents to be sent, the following two fields are available as well:

• ZipFile (byte array): Optional: binary file with ZIP content as a byte array “<ZipFile>” for importing documents, see documentation about “Importing documents in the import”: <ZipFile>
• ZipFilename (string): Required if ZipFile is specified: Name of the ZIP file to be imported (shown in the log file): <ZipFilename>
  CAUTION: The file extension must be cor-rectly indicated, e.g. “import_documents.zip”; entering “import_documents” only would not work.

Response

StatusCode (int): HTTP status code returned by the Umantis solution. “200 (OK)” is returned if every-thing was correctly processed.
ResultMessage (string): Text describing the result of the call.
The WSDL for this can be found here: https://soap.umantis.com/umantis.WebImport.Stable/HttpImport.asmx?wsdl

Import types for Employee Management

Imports for résumé data are also available as full imports. Values that no longer exist in the complete import will therefore be deleted

The following import types are currently available in Employee Management:
For information on content, see Imports.

<Import Type> / Import type	<Category>	Description
CourseExternXml	CourseAll-Import	XML import: Import external participations
CourseExternExcel	-	Excel import: Import external participations
CourseParticipationXml	CourseParticipation-Import	XML import: Import event participations
CourseParticipationExcel	-	Excel import: Import event participations
CoursesXml	Course-Import	XML import: Import events
CoursesExcel	-	Excel import: Import events
CoursesWithoutHistorizationXml	Course-Import	XML import: Import events (partial import)
CoursesWithoutHistorizationExcel	-	Excel import: Import events (partial import)
DynlistsXML	List-Import	XML import: Import selection lists (full import) e.g. OrgUnits
DynlistsExcel	-	Excel import: Import selection lists (full import) e.g. OrgUnits
DynlistsWithoutHistorizationXML	List-Import	XML import: Import selection lists (partial import) e.g. OrgUnits
DynlistsWithoutHistorizationExcel	-	Excel import: Import selection lists (partial import) e.g. OrgUnits
ExternalPersonsXml	CourseParticipation-Import	XML import: Import external individuals
ExternalPersonsExcel	-	Excel import: Import external individuals
PersonsCVContinuingEducationXml	Persons-CV-ContinuingEducation-Import-xml	XML import: Import training
PersonsCVContinuingEducationExcel	-	Excel import: Import training
PersonsCVEducationXml	Persons-CV-Education-Import-xml	XML import: Import education
PersonsCVEducationExcel	-	Excel import: Import education
PersonsCVExperienceXml	Persons-CV-Experience-Import-xml	XML import: Import professional experience
PersonsCVExperienceExcel	-	Excel import: Import professional experience
PersonsCVFurtherEducationXml	Persons-CV-FurtherEducation-Import-xml	XML import: Import higher education
PersonsCVFurtherEducationExcel	-	Excel import: Import higher education
PersonsCVLanguageSkillXml	Persons-CV-LanguageSkills-Import-xml	XML import: Import language skills
PersonsCVLanguageSkillExcel	-	Excel import: Import language skills
StaffingXML	Persons-Jobs-Import	XML import: Import employees (full import)
StaffingExcel	-	Excel import: Import employees (full import)
StaffingWithoutHistorizationXML	Persons-Jobs-Import	XML import: Import employees (partial import)
StaffingWithoutHistorizationExcel	-	Excel import: Import employees (partial import)

Here you will find information on the differences between full imports and partial imports.

Import types for Applicant Management

These import types are currently available in Applicant Management.
For information on content, see Imports.

<Import Type> / Import type	<Category>	Description
ApplicationXML	Applications/People import	XML import: Import applications
ApplicationExcel	-	Excel import: Import applications
DynlistsXML	List-Import	XML import: Import selection lists
DynlistsExcel	-	Excel import: Import selection lists
PositionsXML	Jobs import	XML import: Import jobs
PositionsExcel	-	Excel import: Import jobs
UsersXML	User import	XML import: Import users (full import)
UsersExcel	-	Excel import: Import users (full import)
UsersWithoutHistorizationXML	User import	XML import: Import users (partial import)
UsersWithoutHistorizationExcel	-	Excel import: Import users (partial import)

Notes for connecting to the web service via Visual Studio

Access to the web service is always via HTTPS. This accesses a proxy which forwards the re-quests to the Umantis server via HTTP. Because the internal Umantis servers communicate via HTTP, the link is shown in the WSDL file as HTTP.

In order for the application to work correctly, two settings must be checked in the app.config file:

• Set the security mode to “transport” (corresponds to HTTPS):

   <security mode="Transport">
           <transport clientCredentialType="None" proxyCredentialType="None"
               realm="" />
           <message clientCredentialType="UserName" algorithmSuite="Default" />
   </security>

• Set client address point to “HTTPS”:

   <client>
     <endpoint address="https://soap.umantis.com/umantis.WebImport.Stable/HttpImport.asmx"
         binding="basicHttpBinding" bindingConfiguration="HttpImportSoap"
         contract="umantis.WebImport.Beta.HttpImportSoap" name="HttpImportSoap" />
   </client>

Related topics

• Imports