Organizations

The dynamic TalentLink organization chart structure reflects changes happening in the company. It should be updated whenever departments are created or deleted.

This feature is complemented by the Organisation API. This makes it possible to manage the organization chart from another external system without the need to multiply administrative tasks. Administrators can create unlimited levels of organization, edit their properties, and delete them if required, all from outside TalentLink.

Use Case

A new sales department is created in the Chinese division of the company. An admin user updates the organization chart available in the ERP system. At the same time the TalentLink organization chart structure is modified.

Pre-condition - A new organization is created in the ERP system organization chart structure.

Scenario

  1. START. The ERP system administrator creates a new organisation in the organization chart structure.
  2. The ERP system generates a file using the predefined file definition schema to exchange data with TalentLink.
  3. The ERP system calls the TalentLink Exchange organization web service to create the new organization in TalentLink.
  4. TalentLink Exchange maps the incoming file to the TalentLink organization definition and returns a success or failure message as appropriate.
  5. If TalentLink Exchange successfully manages the request, a new organization is created in TalentLink.
  6. If TalentLink Exchange returns an error, an appropriate SOAP response is sent to the web service client (for SOAP web services).

Response Format

XML

SOAP METHODS

Method addTag is used to add tag value and category to specified organization.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
dptId
Long
[mandatory] This is the ID of the organization in the BackOffice eg: 1360
tagName
String
[mandatory] Name of tag
tagTypeName
String
[mandatory] Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The method createOrganization is used to create a new organization.
The easiest way to build the request to send to the createOrganization method is to first call "getOrganizationExtById" passing in an ID of an existing organization. This will return an "OrganizationExt" object which you can then amend before passing to createOrganization.

Only one organization can be created at a time.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
organizationExt
OrganizationExtDto
Detailed organization data for new organization.
  units
List
List of organization units
    unitExt
UnitExt
Represents organization unit
      name
String
Name of Organization
      description
String
Description of the Organization
      documentSecurityRule
Integer
Sets the document security role.
      dataPrivacyStatement
String
This would be the period of months, for example,12 months
      dataPrivacyStatementForHires
String
This would be the period of months, for example,12 months
      invitationValidity
Long
Sets value for Expiration period for job invitations.
      currency
String
Currency symbol used in this Organization. Click to see possible values
      hideDateOfBirth
Boolean
Represents if organization uses or hides date of birth. Can be False or True
      searchByAgeEnabled
Boolean
Defines if organization uses seaarch by age. Can be false or true.
      parent
OrganizationDto
Represents parent organization in case if it is not top level organization.
        unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
          name
String
Returns name of organization as a xml tag value.
          level
Integer
Returns organization's level.
          id
Long
Returns organization's id.
          code
String
Organization code.
          nameTranslation
String
Translation of the organization name (if defined in BO).
      ofccpMaxCandidates
Long
Defines OFCCP search-recording feature max candidates count.
      ofccpInviteEnforced
Boolean
Describe if organization enforces invite to express interest. Can be False or True.
      ofccpActivated
Boolean
This sets the flag for OFCCP search-recording feature. Compliance settings for the benefit of job seekers and wage earners required of those who do business with the Federal government.
      checkSalaryRange
Boolean
Represents if organization uses enforced salary range check
      nameTranslations
List
List of translated names of the organization
        translation
Translation
This would be the name of the organization you would like to appear in the theme set in the BackOffice.
          language
String
Attribute representing translation language Click to see possible values
          translation
String
Translation content
      themes
List
List of themes for the organization
        theme
ThemeDto
Defines theme for the organization
          id
Long
Internal TLK id of theme
          name
String
Name of theme
          type
String
Type of theme
      emailSignatureID
Long
Represents email signature internal TLK id used by organization
      letterSignatureID
Long
Represents letter signature internal TLK id used by organization.
      awdOwner
String
Represents organization Agency Workers Directive (AWD)Owner owner.
      awdReminderID
Long
Represents organization Agency Workers Directive (AWD) reminder internal TLK ID.
      awdReminderPeriod
Long
Represents organiation Agency Workers Directive (AWD) reminder period.
      mobileAccess
Boolean
Represents if organization has mobile access enabled. Can be False or True
      awdQualifyExpiresReminderID
Long
Represents organization Agency Workers Directive (AWD) quality expires reminder internal TLK id.
      userAssignmentRoles
DRAConfigurationOnDepartmentDto
Represents user assignment roles for organization
        useLocalSettings
Boolean
Represents if organization uses local settings.
        employeeAccessToEss
Boolean
Represents if employees of organization has access to ESS
        roles
List
Represents list of roles for organization.
          role
RoleDto
Role for organization.
            id
Long
Id of the role
            name
String
Name of the role assigned to
            type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
            updateDate
Date
Last update date
            tags
List
List of tags assigned to role
              tag
BasicTagDto
Tag assigned to role
                labelKey
String
[optional] Tag label
                name
String
Tag name
                type
TagTypeDto
Tag type
                  labelKey
String
[optional] Tag type label
                  name
String
Tag type name
      calendarEventWsIntegrationURL
String
Represents calendar event WS integration url used by organization.
      useAccountCalendarEventWsIntegrationURL
Boolean
Defines if organization is using account calendar event WS integration
      requisitionWizardStyle
String
Deprecated, will be removed in TalentLink v.14.0.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  extUnit
UnitExt

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organizationExt
OrganizationExtDto
Detailed organization data that was created.
  units
List
List of organization units
    unitExt
UnitExt
Represents organization unit
      name
String
Name of Organization
      description
String
Description of the Organization
      documentSecurityRule
Integer
Sets the document security role.
      dataPrivacyStatement
String
This would be the period of months, for example,12 months
      dataPrivacyStatementForHires
String
This would be the period of months, for example,12 months
      invitationValidity
Long
Sets value for Expiration period for job invitations.
      currency
String
Currency symbol used in this Organization. Click to see possible values
      hideDateOfBirth
Boolean
Represents if organization uses or hides date of birth. Can be False or True
      searchByAgeEnabled
Boolean
Defines if organization uses seaarch by age. Can be false or true.
      parent
OrganizationDto
Represents parent organization in case if it is not top level organization.
        unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
          name
String
Returns name of organization as a xml tag value.
          level
Integer
Returns organization's level.
          id
Long
Returns organization's id.
          code
String
Organization code.
          nameTranslation
String
Translation of the organization name (if defined in BO).
      ofccpMaxCandidates
Long
Defines OFCCP search-recording feature max candidates count.
      ofccpInviteEnforced
Boolean
Describe if organization enforces invite to express interest. Can be False or True.
      ofccpActivated
Boolean
This sets the flag for OFCCP search-recording feature. Compliance settings for the benefit of job seekers and wage earners required of those who do business with the Federal government.
      checkSalaryRange
Boolean
Represents if organization uses enforced salary range check
      nameTranslations
List
List of translated names of the organization
        translation
Translation
This would be the name of the organization you would like to appear in the theme set in the BackOffice.
          language
String
Attribute representing translation language Click to see possible values
          translation
String
Translation content
      themes
List
List of themes for the organization
        theme
ThemeDto
Defines theme for the organization
          id
Long
Internal TLK id of theme
          name
String
Name of theme
          type
String
Type of theme
      emailSignatureID
Long
Represents email signature internal TLK id used by organization
      letterSignatureID
Long
Represents letter signature internal TLK id used by organization.
      awdOwner
String
Represents organization Agency Workers Directive (AWD)Owner owner.
      awdReminderID
Long
Represents organization Agency Workers Directive (AWD) reminder internal TLK ID.
      awdReminderPeriod
Long
Represents organiation Agency Workers Directive (AWD) reminder period.
      mobileAccess
Boolean
Represents if organization has mobile access enabled. Can be False or True
      awdQualifyExpiresReminderID
Long
Represents organization Agency Workers Directive (AWD) quality expires reminder internal TLK id.
      userAssignmentRoles
DRAConfigurationOnDepartmentDto
Represents user assignment roles for organization
        useLocalSettings
Boolean
Represents if organization uses local settings.
        employeeAccessToEss
Boolean
Represents if employees of organization has access to ESS
        roles
List
Represents list of roles for organization.
          role
RoleDto
Role for organization.
            id
Long
Id of the role
            name
String
Name of the role assigned to
            type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
            updateDate
Date
Last update date
            tags
List
List of tags assigned to role
              tag
BasicTagDto
Tag assigned to role
                labelKey
String
[optional] Tag label
                name
String
Tag name
                type
TagTypeDto
Tag type
                  labelKey
String
[optional] Tag type label
                  name
String
Tag type name
      calendarEventWsIntegrationURL
String
Represents calendar event WS integration url used by organization.
      useAccountCalendarEventWsIntegrationURL
Boolean
Defines if organization is using account calendar event WS integration
      requisitionWizardStyle
String
Deprecated, will be removed in TalentLink v.14.0.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  extUnit
UnitExt
The method deleteOrganization is used to delete a part of a hierarchy of an organization structure or the whole organization structure.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
departmentId
Long
Id of the organization. Please note that you have to make sure you enter the Id which is related to the level of organization you want to remove.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The deleteRoleAssignments method can be used to remove all role assignment for defined choosen organization.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
departmentId
Long
Id of the organization. Please note that you have to make sure you enter the Id which is related to the level of organization you want to have role assignments cleared.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The method getOrganizationById is used to retrieve data about organization based on what is passed in TLK internal id.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
Id of the organization, please note that you have to make sure you enter the Id which is related to the level of organization for which you want information.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organizationDto
OrganizationDto
Returns organization data.
  unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
    name
String
Returns name of organization as a xml tag value.
    level
Integer
Returns organization's level.
    id
Long
Returns organization's id.
    code
String
Organization code.
    nameTranslation
String
Translation of the organization name (if defined in BO).
The method returns details of a single organization based on criteria Shortname. This could be the external Client's organization code.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
shortname
String
Short name of the organization (this is the CODE in TalentLink Back Office)

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organizationExtDto
OrganizationExtDto
Returns detailed organization data.
  units
List
List of organization units
    unitExt
UnitExt
Represents organization unit
      name
String
Name of Organization
      description
String
Description of the Organization
      documentSecurityRule
Integer
Sets the document security role.
      dataPrivacyStatement
String
This would be the period of months, for example,12 months
      dataPrivacyStatementForHires
String
This would be the period of months, for example,12 months
      invitationValidity
Long
Sets value for Expiration period for job invitations.
      currency
String
Currency symbol used in this Organization. Click to see possible values
      hideDateOfBirth
Boolean
Represents if organization uses or hides date of birth. Can be False or True
      searchByAgeEnabled
Boolean
Defines if organization uses seaarch by age. Can be false or true.
      parent
OrganizationDto
Represents parent organization in case if it is not top level organization.
        unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
          name
String
Returns name of organization as a xml tag value.
          level
Integer
Returns organization's level.
          id
Long
Returns organization's id.
          code
String
Organization code.
          nameTranslation
String
Translation of the organization name (if defined in BO).
      ofccpMaxCandidates
Long
Defines OFCCP search-recording feature max candidates count.
      ofccpInviteEnforced
Boolean
Describe if organization enforces invite to express interest. Can be False or True.
      ofccpActivated
Boolean
This sets the flag for OFCCP search-recording feature. Compliance settings for the benefit of job seekers and wage earners required of those who do business with the Federal government.
      checkSalaryRange
Boolean
Represents if organization uses enforced salary range check
      nameTranslations
List
List of translated names of the organization
        translation
Translation
This would be the name of the organization you would like to appear in the theme set in the BackOffice.
          language
String
Attribute representing translation language Click to see possible values
          translation
String
Translation content
      themes
List
List of themes for the organization
        theme
ThemeDto
Defines theme for the organization
          id
Long
Internal TLK id of theme
          name
String
Name of theme
          type
String
Type of theme
      emailSignatureID
Long
Represents email signature internal TLK id used by organization
      letterSignatureID
Long
Represents letter signature internal TLK id used by organization.
      awdOwner
String
Represents organization Agency Workers Directive (AWD)Owner owner.
      awdReminderID
Long
Represents organization Agency Workers Directive (AWD) reminder internal TLK ID.
      awdReminderPeriod
Long
Represents organiation Agency Workers Directive (AWD) reminder period.
      mobileAccess
Boolean
Represents if organization has mobile access enabled. Can be False or True
      awdQualifyExpiresReminderID
Long
Represents organization Agency Workers Directive (AWD) quality expires reminder internal TLK id.
      userAssignmentRoles
DRAConfigurationOnDepartmentDto
Represents user assignment roles for organization
        useLocalSettings
Boolean
Represents if organization uses local settings.
        employeeAccessToEss
Boolean
Represents if employees of organization has access to ESS
        roles
List
Represents list of roles for organization.
          role
RoleDto
Role for organization.
            id
Long
Id of the role
            name
String
Name of the role assigned to
            type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
            updateDate
Date
Last update date
            tags
List
List of tags assigned to role
              tag
BasicTagDto
Tag assigned to role
                labelKey
String
[optional] Tag label
                name
String
Tag name
                type
TagTypeDto
Tag type
                  labelKey
String
[optional] Tag type label
                  name
String
Tag type name
      calendarEventWsIntegrationURL
String
Represents calendar event WS integration url used by organization.
      useAccountCalendarEventWsIntegrationURL
Boolean
Defines if organization is using account calendar event WS integration
      requisitionWizardStyle
String
Deprecated, will be removed in TalentLink v.14.0.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  extUnit
UnitExt
The method getOrganizationExtById returns details of a single organization based on what is passed in TLK internal id.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
Id of the organization, please note that you have to make sure you enter the Id which is related to the level of organization for which you want information.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organizationExtDto
OrganizationExtDto
Returns detailed organization data.
  units
List
List of organization units
    unitExt
UnitExt
Represents organization unit
      name
String
Name of Organization
      description
String
Description of the Organization
      documentSecurityRule
Integer
Sets the document security role.
      dataPrivacyStatement
String
This would be the period of months, for example,12 months
      dataPrivacyStatementForHires
String
This would be the period of months, for example,12 months
      invitationValidity
Long
Sets value for Expiration period for job invitations.
      currency
String
Currency symbol used in this Organization. Click to see possible values
      hideDateOfBirth
Boolean
Represents if organization uses or hides date of birth. Can be False or True
      searchByAgeEnabled
Boolean
Defines if organization uses seaarch by age. Can be false or true.
      parent
OrganizationDto
Represents parent organization in case if it is not top level organization.
        unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
          name
String
Returns name of organization as a xml tag value.
          level
Integer
Returns organization's level.
          id
Long
Returns organization's id.
          code
String
Organization code.
          nameTranslation
String
Translation of the organization name (if defined in BO).
      ofccpMaxCandidates
Long
Defines OFCCP search-recording feature max candidates count.
      ofccpInviteEnforced
Boolean
Describe if organization enforces invite to express interest. Can be False or True.
      ofccpActivated
Boolean
This sets the flag for OFCCP search-recording feature. Compliance settings for the benefit of job seekers and wage earners required of those who do business with the Federal government.
      checkSalaryRange
Boolean
Represents if organization uses enforced salary range check
      nameTranslations
List
List of translated names of the organization
        translation
Translation
This would be the name of the organization you would like to appear in the theme set in the BackOffice.
          language
String
Attribute representing translation language Click to see possible values
          translation
String
Translation content
      themes
List
List of themes for the organization
        theme
ThemeDto
Defines theme for the organization
          id
Long
Internal TLK id of theme
          name
String
Name of theme
          type
String
Type of theme
      emailSignatureID
Long
Represents email signature internal TLK id used by organization
      letterSignatureID
Long
Represents letter signature internal TLK id used by organization.
      awdOwner
String
Represents organization Agency Workers Directive (AWD)Owner owner.
      awdReminderID
Long
Represents organization Agency Workers Directive (AWD) reminder internal TLK ID.
      awdReminderPeriod
Long
Represents organiation Agency Workers Directive (AWD) reminder period.
      mobileAccess
Boolean
Represents if organization has mobile access enabled. Can be False or True
      awdQualifyExpiresReminderID
Long
Represents organization Agency Workers Directive (AWD) quality expires reminder internal TLK id.
      userAssignmentRoles
DRAConfigurationOnDepartmentDto
Represents user assignment roles for organization
        useLocalSettings
Boolean
Represents if organization uses local settings.
        employeeAccessToEss
Boolean
Represents if employees of organization has access to ESS
        roles
List
Represents list of roles for organization.
          role
RoleDto
Role for organization.
            id
Long
Id of the role
            name
String
Name of the role assigned to
            type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
            updateDate
Date
Last update date
            tags
List
List of tags assigned to role
              tag
BasicTagDto
Tag assigned to role
                labelKey
String
[optional] Tag label
                name
String
Tag name
                type
TagTypeDto
Tag type
                  labelKey
String
[optional] Tag type label
                  name
String
Tag type name
      calendarEventWsIntegrationURL
String
Represents calendar event WS integration url used by organization.
      useAccountCalendarEventWsIntegrationURL
Boolean
Defines if organization is using account calendar event WS integration
      requisitionWizardStyle
String
Deprecated, will be removed in TalentLink v.14.0.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  extUnit
UnitExt
The method getOrganizations is used to retrieve all organizations levels for example:
Level 1 = Demo (iD=Demo)
Level 2 = Engineering (iD=Demo-Engineering)
This can have many levels and is purely on the structure the client has set for its organization.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
organizationLevel
Integer
Represents level of organization to which hierarchy should be returned. E.g. if 1 will be passed only level 1 organization will be returned, for 2 organizations level 1 and 2 will be returned. If not set all organization will be returned.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organization
OrganizationsListDto
Returns all organizations for a client and this includes all levels within the hierarchy
  organization
OrganizationDto
Represents organization
    unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
      name
String
Returns name of organization as a xml tag value.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
Method getTagTypes is used to get all possible tag types.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
type
Collection
Tag Type list
  labelKey
String
[optional] Tag type label
  name
String
Tag type name
Method getTaggedOrganizations is used to return list of organizations that are assigned to tag.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
tagName
String
Name of tag
tagTypeName
String
Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organization
Collection
List of Organization data that were assigned to specified tag and category.
  unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
    name
String
Returns name of organization as a xml tag value.
    level
Integer
Returns organization's level.
    id
Long
Returns organization's id.
    code
String
Organization code.
    nameTranslation
String
Translation of the organization name (if defined in BO).
Method getTagsForType is used to return list of possible tags for given type.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
tagTypeName
String
[mandatory] Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
tag
Collection
List of tags
  labelKey
String
[optional] Tag label
  name
String
Tag name
  type
TagTypeDto
Tag type
    labelKey
String
[optional] Tag type label
    name
String
Tag type name
The method moveOrganization is used to move an organization up or down in the hierarchy.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
departmentId
Long
Id of the organization, please note that you have to make sure you enter the Id which is related to the level of organization you want to move.
destParentId
Long
Id of the parent organization to which you want to move to.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
Email and letter signatures need to be defined and configured in the BackOffice first. This method only propagates already created signatures from one Department to other departments.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
departmentId
Long
Organization internal TLK ID for which propagation should occur.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
This method reassignJobs can be used to reassign all jobs from souce organization to destination organization.

Post Parameter

 
Parameter Data Type Description
sourceDptId
Long
Id of the organization. Please note that you have to make sure you enter the Id which is related to the level of organization you want to move jobs from.
destDptId
Long
Id of the organization. Please note that you have to make sure you enter the Id which is related to the level of organization you want to move jobs to.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The method updateOrganization is used to update an organization details within the hierarchy.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
organizationExt
OrganizationExtDto
Organization detailed data for update.
  units
List
List of organization units
    unitExt
UnitExt
Represents organization unit
      name
String
Name of Organization
      description
String
Description of the Organization
      documentSecurityRule
Integer
Sets the document security role.
      dataPrivacyStatement
String
This would be the period of months, for example,12 months
      dataPrivacyStatementForHires
String
This would be the period of months, for example,12 months
      invitationValidity
Long
Sets value for Expiration period for job invitations.
      currency
String
Currency symbol used in this Organization. Click to see possible values
      hideDateOfBirth
Boolean
Represents if organization uses or hides date of birth. Can be False or True
      searchByAgeEnabled
Boolean
Defines if organization uses seaarch by age. Can be false or true.
      parent
OrganizationDto
Represents parent organization in case if it is not top level organization.
        unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
          name
String
Returns name of organization as a xml tag value.
          level
Integer
Returns organization's level.
          id
Long
Returns organization's id.
          code
String
Organization code.
          nameTranslation
String
Translation of the organization name (if defined in BO).
      ofccpMaxCandidates
Long
Defines OFCCP search-recording feature max candidates count.
      ofccpInviteEnforced
Boolean
Describe if organization enforces invite to express interest. Can be False or True.
      ofccpActivated
Boolean
This sets the flag for OFCCP search-recording feature. Compliance settings for the benefit of job seekers and wage earners required of those who do business with the Federal government.
      checkSalaryRange
Boolean
Represents if organization uses enforced salary range check
      nameTranslations
List
List of translated names of the organization
        translation
Translation
This would be the name of the organization you would like to appear in the theme set in the BackOffice.
          language
String
Attribute representing translation language Click to see possible values
          translation
String
Translation content
      themes
List
List of themes for the organization
        theme
ThemeDto
Defines theme for the organization
          id
Long
Internal TLK id of theme
          name
String
Name of theme
          type
String
Type of theme
      emailSignatureID
Long
Represents email signature internal TLK id used by organization
      letterSignatureID
Long
Represents letter signature internal TLK id used by organization.
      awdOwner
String
Represents organization Agency Workers Directive (AWD)Owner owner.
      awdReminderID
Long
Represents organization Agency Workers Directive (AWD) reminder internal TLK ID.
      awdReminderPeriod
Long
Represents organiation Agency Workers Directive (AWD) reminder period.
      mobileAccess
Boolean
Represents if organization has mobile access enabled. Can be False or True
      awdQualifyExpiresReminderID
Long
Represents organization Agency Workers Directive (AWD) quality expires reminder internal TLK id.
      userAssignmentRoles
DRAConfigurationOnDepartmentDto
Represents user assignment roles for organization
        useLocalSettings
Boolean
Represents if organization uses local settings.
        employeeAccessToEss
Boolean
Represents if employees of organization has access to ESS
        roles
List
Represents list of roles for organization.
          role
RoleDto
Role for organization.
            id
Long
Id of the role
            name
String
Name of the role assigned to
            type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
            updateDate
Date
Last update date
            tags
List
List of tags assigned to role
              tag
BasicTagDto
Tag assigned to role
                labelKey
String
[optional] Tag label
                name
String
Tag name
                type
TagTypeDto
Tag type
                  labelKey
String
[optional] Tag type label
                  name
String
Tag type name
      calendarEventWsIntegrationURL
String
Represents calendar event WS integration url used by organization.
      useAccountCalendarEventWsIntegrationURL
Boolean
Defines if organization is using account calendar event WS integration
      requisitionWizardStyle
String
Deprecated, will be removed in TalentLink v.14.0.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  extUnit
UnitExt

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
organizationExt
Void