Tm ImportEmployee

Click here for an overview of Terminology. Read about the common setup of RESTFul apis

Please read the API Usage Notice before implementing API consumption.

URL

PROD: https://manager-api.hr-manager.net/Remoting.svc

Method used to do the Import is "EmployeeImport".

Minimum fields required in order to create the Employee.


AuthenticationToken	This token is used to validate the request so that only authorized users can perform the import. This is to provide the security to the API and restrict the unauthorized access. We can either user customer specific API Key or the Master Key to get access to the system.

CustomerId `OR:`TenantId	This is customer identification id to let system know where a particular employee should be imported One of these parameters need to be set
DepartmentId	This the department in which the Employee has to be imported. If departmentId is not passed, root department for the customer will be used.
ReferenceToken	This field is required for the Import Employee request, however we can pass any value for now in this field
AccessLevelList	This object holds all the information related to the User Access Level which the given employee will be granted.
FirstName	Employee's first name.
LastName	Employee's last name.
Username	Employee's email.

Basic request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://schemas.hr-manager.net/remoting/1.0/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:hrm="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:EmployeeImport>
         <ns:request>
            <ns:AuthenticationToken></ns:AuthenticationToken>
            <ns:CustomerId></ns:CustomerId>
            <ns:DepartmentId>
               <ns:Id></ns:Id>
            </ns:DepartmentId>
            <ns:ReferenceToken></ns:ReferenceToken>
            <ns:Employee>
               <ns:Details>
                  <ns:AccessLevelList>
                     <ns:UserAccessInfo>
                        <ns:DepartmentId>
                           <ns:Id></ns:Id>
                           <ns:ThirdPartyId></ns:ThirdPartyId>
                        </ns:DepartmentId>
                        <ns:UserRoleList>
                           <ns:RemotableIdOfint>
                              <ns:Id></ns:Id>
                              <ns:ThirdPartyId></ns:ThirdPartyId>
                           </ns:RemotableIdOfint>
                        </ns:UserRoleList>
                     </ns:UserAccessInfo>
                  </ns:AccessLevelList>
               </ns:Details>
               <ns:FirstName></ns:FirstName>
               <ns:LastName></ns:LastName>
               <ns:Username></ns:Username>
            </ns:Employee>
         </ns:request>
      </ns:EmployeeImport>
   </soapenv:Body>
</soapenv:Envelope>

Complete Request object is as follow:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://schemas.hr-manager.net/remoting/1.0/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:hrm="http://schemas.datacontract.org/2004/07/HRMTS.TalentManager.Common.Models.Remoting.Employees">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:EmployeeImport>
         <!--Optional:-->
         <ns:request>
            <ns:AuthenticationToken>?</ns:AuthenticationToken>
            <ns:CustomerId>?</ns:CustomerId>
            <!--Optional:-->
            <ns:DepartmentId>
               <!--Optional:-->
               <ns:Id>?</ns:Id>
               <!--Optional:-->
               <ns:ThirdPartyId>?</ns:ThirdPartyId>
            </ns:DepartmentId>
            <ns:ReferenceToken>?</ns:ReferenceToken>
            <!--Optional:-->
            <ns:SystemLanguageType>?</ns:SystemLanguageType>
            <!--Optional:-->
            <ns:Employee>
               <!--Optional:-->
               <ns:Id>
                  <!--Optional:-->
                  <ns:Id>?</ns:Id>
                  <!--Optional:-->
                  <ns:ThirdPartyId>?</ns:ThirdPartyId>
               </ns:Id>
               <!--Optional:-->
               <ns:ParentDepartmentId>
                  <!--Optional:-->
                  <ns:Id>?</ns:Id>
                  <!--Optional:-->
                  <ns:ThirdPartyId>?</ns:ThirdPartyId>
               </ns:ParentDepartmentId>
               <!--Optional:-->
               <ns:Title>?</ns:Title>
               <!--Optional:-->
               <ns:Details>
                  <ns:AccessLevelList>
                     <!--Zero or more repetitions:-->
                     <ns:UserAccessInfo>
                        <!--Optional:-->
                        <ns:DepartmentId>
                           <!--Optional:-->
                           <ns:Id>?</ns:Id>
                           <!--Optional:-->
                           <ns:ThirdPartyId>?</ns:ThirdPartyId>
                        </ns:DepartmentId>
                        <!--Optional:-->
                        <ns:UserRoleList>
                           <!--Zero or more repetitions:-->
                           <ns:RemotableIdOfint>
                              <!--Optional:-->
                              <ns:Id>?</ns:Id>
                              <!--Optional:-->
                              <ns:ThirdPartyId>?</ns:ThirdPartyId>
                           </ns:RemotableIdOfint>
                        </ns:UserRoleList>
                     </ns:UserAccessInfo>
                  </ns:AccessLevelList>
                  <!--Optional:-->
                  <ns:Address>?</ns:Address>
                  <!--Optional:-->
                  <ns:Address2>?</ns:Address2>
                  <!--Optional:-->
                  <ns:AlternateEmail>?</ns:AlternateEmail>
                  <!--Optional:-->
                  <ns:AnniversaryDate>?</ns:AnniversaryDate>
                  <!--Optional:-->
                  <ns:AppraisalImageFileName>?</ns:AppraisalImageFileName>
                  <!--Optional:-->
                  <ns:AvailabilityDate>?</ns:AvailabilityDate>
                  <!--Optional:-->
                  <ns:BankAccountNumber>?</ns:BankAccountNumber>
                  <!--Optional:-->
                  <ns:BankRegistrationNumber>?</ns:BankRegistrationNumber>
                  <!--Optional:-->
                  <ns:BirthDate>?</ns:BirthDate>
                  <!--Optional:-->
                  <ns:City>?</ns:City>
                  <!--Optional:-->
                  <ns:CostCenter>?</ns:CostCenter>
                  <!--Optional:-->
                  <ns:Country>?</ns:Country>
                  <!--Optional:-->
                  <ns:EducationLevelId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:EducationLevelId>
                  <!--Optional:-->
                  <ns:EmploymentDate>?</ns:EmploymentDate>
                  <!--Optional:-->
                  <ns:EmploymentEndDate>?</ns:EmploymentEndDate>
                  <!--Optional:-->
                  <ns:EmploymentId>?</ns:EmploymentId>
                  <!--Optional:-->
                  <ns:FTE>?</ns:FTE>
                  <!--Optional:-->
                  <ns:Gender>?</ns:Gender>
                  <!--Optional:-->
                  <ns:JobTitleId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:JobTitleId>
                  <!--Optional:-->
                  <ns:JobTypeId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:JobTypeId>
                  <!--Optional:-->
                  <ns:KeyInformationAnswerList>
                     <!--Zero or more repetitions:-->
                     <ns:EmployeeKeyInformationAnswer>
                        <!--Optional:-->
                        <ns:AnswerGroupId>?</ns:AnswerGroupId>
                        <!--Optional:-->
                        <ns:AnswerOptionsIdList>
                           <!--Zero or more repetitions:-->
                           <arr:int>?</arr:int>
                        </ns:AnswerOptionsIdList>
                        <!--Optional:-->
                        <ns:CustomAnswer>?</ns:CustomAnswer>
                        <!--Optional:-->
                        <ns:DateTimeAnswer>?</ns:DateTimeAnswer>
                        <!--Optional:-->
                        <ns:ParentAnswerOptionId>?</ns:ParentAnswerOptionId>
                        <!--Optional:-->
                        <ns:ParentQuestionId>?</ns:ParentQuestionId>
                        <!--Optional:-->
                        <ns:QuestionGroupId>?</ns:QuestionGroupId>
                        <!--Optional:-->
                        <ns:QuestionId>?</ns:QuestionId>
                        <!--Optional:-->
                        <ns:RowId>?</ns:RowId>
                     </ns:EmployeeKeyInformationAnswer>
                  </ns:KeyInformationAnswerList>
                  <!--Optional:-->
                  <ns:LastName2>?</ns:LastName2>
                  <!--Optional:-->
                  <ns:LastWorkingDate>?</ns:LastWorkingDate>
                  <!--Optional:-->
                  <ns:MaritalStatusId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:MaritalStatusId>
                  <!--Optional:-->
                  <ns:Nationality>?</ns:Nationality>
                  <!--Optional:-->
                  <ns:NoticeTimeId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:NoticeTimeId>
                  <!--Optional:-->
                  <ns:ParentEmployee>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:ParentEmployee>
                  <!--Optional:-->
                  <ns:ParentEmployeeId>?</ns:ParentEmployeeId>
                  <!--Optional:-->
                  <ns:PersonId>?</ns:PersonId>
                  <!--Optional:-->
                  <ns:PhoneFax>?</ns:PhoneFax>
                  <!--Optional:-->
                  <ns:PhoneMobile>?</ns:PhoneMobile>
                  <!--Optional:-->
                  <ns:PhoneMobileCountryCode>?</ns:PhoneMobileCountryCode>
                  <!--Optional:-->
                  <ns:PhonePrivate>?</ns:PhonePrivate>
                  <!--Optional:-->
                  <ns:PhonePrivateCountryCode>?</ns:PhonePrivateCountryCode>
                  <!--Optional:-->
                  <ns:PhoneWork>?</ns:PhoneWork>
                  <!--Optional:-->
                  <ns:PhoneWorkCountryCode>?</ns:PhoneWorkCountryCode>
                  <!--Optional:-->
                  <ns:ProbationPeriodId>?</ns:ProbationPeriodId>
                  <!--Optional:-->
                  <ns:ReasonForLeavingId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:ReasonForLeavingId>
                  <!--Optional:-->
                  <ns:RelativeInfo1Email>?</ns:RelativeInfo1Email>
                  <!--Optional:-->
                  <ns:RelativeInfo1Name>?</ns:RelativeInfo1Name>
                  <!--Optional:-->
                  <ns:RelativeInfo1Phone>?</ns:RelativeInfo1Phone>
                  <!--Optional:-->
                  <ns:RelativeInfo1RelationId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:RelativeInfo1RelationId>
                  <!--Optional:-->
                  <ns:RelativeInfo2Email>?</ns:RelativeInfo2Email>
                  <!--Optional:-->
                  <ns:RelativeInfo2Name>?</ns:RelativeInfo2Name>
                  <!--Optional:-->
                  <ns:RelativeInfo2Phone>?</ns:RelativeInfo2Phone>
                  <!--Optional:-->
                  <ns:RelativeInfo2RelationId>
                     <!--Optional:-->
                     <ns:Id>?</ns:Id>
                     <!--Optional:-->
                     <ns:ThirdPartyId>?</ns:ThirdPartyId>
                  </ns:RelativeInfo2RelationId>
                  <!--Optional:-->
                  <ns:ResignationDate>?</ns:ResignationDate>
                  <!--Optional:-->
                  <ns:Salary>?</ns:Salary>
                  <!--Optional:-->
                  <ns:SeniorityDate>?</ns:SeniorityDate>
                  <!--Optional:-->
                  <ns:StaffCategory>?</ns:StaffCategory>
                  <!--Optional:-->
                  <ns:ThirdPartyUsername>?</ns:ThirdPartyUsername>
                  <!--Optional:-->
                  <ns:WorkLocation>?</ns:WorkLocation>
                  <!--Optional:-->
                  <ns:WorkPercentage>?</ns:WorkPercentage>
                  <!--Optional:-->
                  <ns:WorkTimeEnd>?</ns:WorkTimeEnd>
                  <!--Optional:-->
                  <ns:WorkTimeStart>?</ns:WorkTimeStart>
                  <!--Optional:-->
                  <ns:Zip>?</ns:Zip>
               </ns:Details>
               <ns:FirstName>?</ns:FirstName>
               <ns:LastName>?</ns:LastName>
               <ns:Username>?</ns:Username>
               <!--Optional:-->
               <hrm:CreatedBy>?</hrm:CreatedBy>
               <!--Optional:-->
               <hrm:EducationArea>?</hrm:EducationArea>
               <!--Optional:-->
               <hrm:EducationLevel>?</hrm:EducationLevel>
               <!--Optional:-->
               <hrm:EducationTitle>?</hrm:EducationTitle>
               <!--Optional:-->
               <hrm:EmployeeDocuments>
                  <!--Zero or more repetitions:-->
                  <hrm:EmployeeDocument>
                     <!--Optional:-->
                     <hrm:Content>cid:944553874416</hrm:Content>
                     <!--Optional:-->
                     <hrm:ContentSize>?</hrm:ContentSize>
                     <!--Optional:-->
                     <hrm:ContentType>?</hrm:ContentType>
                     <!--Optional:-->
                     <hrm:Created>?</hrm:Created>
                     <!--Optional:-->
                     <hrm:CreatedBy>?</hrm:CreatedBy>
                     <!--Optional:-->
                     <hrm:DocumentCategoryId>?</hrm:DocumentCategoryId>
                     <!--Optional:-->
                     <hrm:EmployeeId>?</hrm:EmployeeId>
                     <!--Optional:-->
                     <hrm:FileName>?</hrm:FileName>
                     <!--Optional:-->
                     <hrm:IsEmployeeVisible>?</hrm:IsEmployeeVisible>
                     <!--Optional:-->
                     <hrm:LastUpdated>?</hrm:LastUpdated>
                     <!--Optional:-->
                     <hrm:LastUpdatedBy>?</hrm:LastUpdatedBy>
                     <!--Optional:-->
                     <hrm:StorageId>?</hrm:StorageId>
                  </hrm:EmployeeDocument>
               </hrm:EmployeeDocuments>
               <!--Optional:-->
               <hrm:HasReferences>?</hrm:HasReferences>
               <!--Optional:-->
               <hrm:MainWorkArea>?</hrm:MainWorkArea>
               <!--Optional:-->
               <hrm:Password>?</hrm:Password>
               <!--Optional:-->
               <hrm:PreferredLanguageId>?</hrm:PreferredLanguageId>
               <!--Optional:-->
               <hrm:RoleIds>?</hrm:RoleIds>
               <!--Optional:-->
               <hrm:WebSite>?</hrm:WebSite>
               <!--Optional:-->
               <hrm:YearsHigherEdu>?</hrm:YearsHigherEdu>
               <!--Optional:-->
               <hrm:YearsInMainWorkAreaRole>?</hrm:YearsInMainWorkAreaRole>
               <!--Optional:-->
               <hrm:YearsWorkExperience>?</hrm:YearsWorkExperience>
            </ns:Employee>
         </ns:request>
      </ns:EmployeeImport>
   </soapenv:Body>
</soapenv:Envelope>