Candidate Assessments

In order to access this endpoint ensure that you do a GET request with an Authorization header containing your access token.

Headers:
Authorization : {token}
Content-Type : application/json

Result Codes

200 OK
201 Created
400 Bad request
403 Forbidden
500 Internal server error

Get Candidate Assessment

Returns a Candidate Assessment using a Candidate Id as an integer and an Assessment Id as a guid

GET https://api.simplify.hr/v1/CandidateAssessment/{candidate-id}/{assessment-id}

Candidate Assessment Result

Field Name	Type	Description
Id	guid	Assessment Id
CandidateId	int	Candidate Id
AssessmentProvider	string	Assessment Provider
AssessmentGroup	string	Assessment Group
AssessmentName	string	Assessment Name
Score	string	Assessment Score
CompletedDate	datetime	Assessment Completed Date
ResultLink	string	Assessment Result Url
CreatedDate	datetime	Record Created Date
Document	Assessment Document Object	See below

Assessment Document


Id	guid	Document Identifier
FileName	string	Name of File
CreatedDate	datetime	Record Created Date

Sample Result

{
	"Id": "49a22445-706d-497f-bf82-f1fbfd9b3e92",
	"CandidateId": 1,
	"AssessmentProvider": "Sample Provider",
	"AssessmentGroup": "Sample Group",
	"AssessmentName": "Sample Name",
	"Score": "Sample Score",
	"CompletedDate": "2023-01-25T00:00:00",
	"ResultLink": "Sample Url",
	"CreatedDate": "2023-01-10T13:14:51.14",
	"Document": [
		{
			"Id": "27f9447f-0757-4c07-b43d-99fdc3ba22ae",
			"FileName": "Assessment.docx",
			"CreatedDate": "2023-01-23T13:17:42.85"
		}
	]
}

Get Candidate Assessments by Candidate Id

Returns a list of Candidate Assessments using a Candidate Id as an integer

GET https://api.simplify.hr/v1/CandidateAssessment/{candidate-id}

Create a Candidate Assessment

Create a Candidate Assessment using a Candidate Id as an integer

POST https://api.simplify.hr/v1/CandidateAssessment/{candidate-id}

Response Header
location: https://api.simplify.hr/v1/CandidateAssessment/{candidate-id}/{assessment-id}

Update a Candidate Assessment

Update a Candidate Assessment using a Candidate Id as an integer and an Assessment Id as a guid

POST https://api.simplify.hr/v1/CandidateAssessment/{candidate-id}/{assessment-id}

Create and Update Candidate Assessment Post Data

Field Name	Type	Description
AssessmentProvider	string	Required
AssessmentGroup	string	Optional
AssessmentName	string	Required
Score	string	Required
CompletedDate	DateTime	Required
ResultLink	string	Optional

Sample Create and Update Post Data

{
	"AssessmentProvider": "Sample Provider",
	"AssessmentGroup": "Sample Group",
	"AssessmentName": "Sample Name",
	"Score": "Sample Score",
	"CompletedDate": "2023-01-25T00:00:00",
	"ResultLink": "Sample Url"
}

Upload a Candidate Assessment Document

Post https://api.simplify.hr/v1/CandidateAssessment/Document/{candidate-id}/{assessment-id}

Request Headers:
Content-Type: multipart/form-data;
Authorization: {Token}

Request Body Example:
-----------------------------{...boundary}
Content-Disposition: form-data; name="Assessment"; filename="Assessment.pdf"
Content-Type: application/pdf

...contents of Assessment.pdf file

-----------------------------{...boundary}

Delete a Candidate Assessment

Delete a Candidate Assessment using a Candidate Id as an integer and an Assessment Id as a guid