SOAP API - getCandidateDetail

The table summarizes the SOAP API - getCandidateDetail.

Request Uses the getCandidateDetailelement (from the DirectoryService schema)
Parameter notes
  • ldap-alias: the alias of the LDAP entry from which the candidate is taken. LDAP connection shared resources are named with the prefix ldap/de/ in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the ldap/de/ prefix. Can be obtained from a previous call to listCandidateResources .
  • ldap-dn: the Distinguished Name (DN) to which the query is restricted. This is relative to, and in addition to, any base DN specified in the LDAP connection shared resource's URL. Can be obtained from a previous call to listCandidateResources .
  • container-id: Identifies the LDAP Container from which the candidate was resolved
  • secondary-ref: Identifies the LDAP entry in the secondary LDAP source.
Response Returns a getCandidateDetailResponseelement (from the DirectoryService schema).
  • guid: the GUID of an existing resource.
  • name: the name of an existing resource, or the name that will be assigned (by default) to the resource created from this candidate entry.
Example Request:
<soapenv:Body>
      <dir:getCandidateDetail ldap-alias="easyAs" ldap-dn="OU=John Eustace, OU=Swindon, OU=AllEmployees, O=easyAsInsurance" container-id="1">
      </dir:getCandidateDetail>
</soapenv:Body>
Response:
<SOAP-ENV:Body>
      <getCandidateDetailResponse container-id="1" guid="69067D11-5C43-4164-BA8C-1C563DF4727B" ldap-alias="easyAs" ldap-dn="OU=John Eustace, OU=Swindon, OU=AllEmployees, O=easyAsInsurance" name="John Eustace" xmlns="http://directory.api.de.bpm.tibco.com"/>
</SOAP-ENV:Body>