Parameter

Description

PartnerKey

A key SilkRoad gives to each partner. Points to that partner’s data in a shared database.

SharedSecret

A shared secret used, to along with the RETURN_ADDRESS, to authenticate the request.

LifesuiteCode

A code to identify the SilkRoad Onboarding customer that was entered as part of the customer configuration. SilkRoad Onboarding validates that it is pointing to the right customer to make sure there has been no misconfiguration.

Class

The class of this service that was entered as part of the configuration. Staging, Prod, Test. SilkRoad Onboarding uses this to validate it is pointed to the right class to make sure there had been no misconfiguration.

ATSName

SilkRoad Onboarding stores this so that it can be placed in the audit notes.

RecruiterName

SilkRoad Onboarding stores this so that it can be placed in the audit notes.

RecruiterID

An ID to identify the recruiter. Reserved for future use.

ATSCandidateID

ID that your ATS will use to identify the newly hired employee. This key must be immutable with respect to the newly hired employee for this job. SilkRoad Onboarding uses this ID to determine whether the employee has been already imported.

If the candidate were subsequently hired into a different job, SilkRoad Onboarding would expect a different ATSCandidateID.

SilkRoad Onboarding:

• Returns this ID, together with the AuthenticationToken when it returns the user to your ATS.
• Stores this ID with the employee event. SilkRoad Onboarding does not allow two events to be created with the same ATSCandidateID.