attributes “Parameterized” These attributes are used to determine the candidate on whom the form result should be associated to. Rules: If resumeKey value is passed then no other candidate information is required like the FirstName, LastName, email and homePhone is not necessary. If the Candidate form in BrassRing where the results are being sent is a form, then the Req “per Req” number must be sent as well. The Req number is sent in the attribute (i.e. 100BR, 23443BR). “autoreq” If resumeKey value is not available, then FirstName, LastName and (email or homePhone) value must be sent. The API utilizes these values to determine an existing candidate in the system. formId is the Form identifier for the Candidate form if the form already exists in the system. If formId value is passed then none of the parameterized attributes are required to be sent since the formId value knows exactly what BrassRing form it must update. brUID is an internal representation of the Candidate ID in BrassRing. It is unlikely that an external system would be able to reference this value. OrderID is the assessment Order ID used mainly for assessments like SHL. All tags in the Form header are required even if they are blank. <form formTypeId="XXXX" formName="EEO_FORM" action="UPDATE" FirstName="First" LastName="Last" homePhone="111-111-1111" email="" resumeKey="" language="EN"> XML Schemas Sample XML Request Below is a sample Form XML file for your reference. <?xml version=”1.0”?> <Envelope version=”01.00”> <Sender> <Id>INTEGRATIONID</Id> <Credential>CLIENTID</Credential> </Sender>
“Parameterized” attributes These attributes are used to determine the candidate on whom the form result should be associated to. Rules: If resumeKey value is passed then no other candidate information is required like the FirstName, LastName, email and homePhone is not necessary. If the Candidate form in BrassRing where the results are being sent is a “per Req” form, then the Req number must be sent as well. The Req number is sent in the “autoreq” attribute (i.e. 100BR, 23443BR). If resumeKey value is not available, then FirstName, LastName and (email or homePhone) value must be sent. The API utilizes these values to determine an existing candidate in the system. formId is the Form identifier for the Candidate form if the form already exists in the system. If formId value is passed then none of the parameterized attributes are required to be sent since the formId value knows exactly what BrassRing form it must update. brUID is an internal representation of the Candidate ID in BrassRing. It is unlikely that an external system would be able to reference this value. OrderID is the assessment Order ID used mainly for assessments like SHL. All tags in the Form header are required even if they are blank. <form formTypeId="XXXX" formName="EEO_FORM" action="UPDATE" FirstName="First" LastName="Last" homePhone="111-111-1111" email="" resumeKey="" language="EN"> XML Schemas Sample XML Request Below is a sample Form XML file for your reference. <?xml version=”1.0”?> <Envelope version=”01.00”> <Sender> <Id>INTEGRATIONID</Id> <Credential>CLIENTID</Credential> </Sender>