assessment
order

Create an order

post/assessment/{connection_id}/order

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/assessment/{connection_id}/order
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring required

Workspace ID that this order belongs to (reference to KmsSpace)

connection_idstring required

Connection ID that this order belongs to

webhook_idstring

Webhook ID that this order belongs to

package_idstring

Assessment package ID

target_urlstring

URL to redirect user to after assessment

status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
referencestring

ATS-specific reference ID

application_idstring

ATS application ID

job_idstring

ATS job ID

company_idstring

ATS company ID (reference to AtsCompany)

candidate_idstring

ATS candidate ID

employee_idstring

ATS employee ID

profile_namestring
profile_first_namestring
profile_last_namestring
profile_resume_urlstring
profile_ip_addressstring

XXX.XXX.XXX.XXX

profile_date_of_birthstring

YYYY-MM-DD

profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
profile_emailsstring[]
profile_telephonesstring[]
profile_national_identifierstring
profile_social_media_urlsstring[]
response_completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_expires_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_issued_atstring date-time

Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
response_scorenumber

Assessment score (e.g., 0-100)

response_max_scorenumber

Maximum possible score

response_urlstring

URL to view detailed results

response_redirect_urlstring

URL to redirect the user to complete assessment

response_download_urlsstring[]

Report download URLs

response_sourcestring
rawunknown

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring required

Workspace ID that this order belongs to (reference to KmsSpace)

connection_idstring required

Connection ID that this order belongs to

webhook_idstring

Webhook ID that this order belongs to

package_idstring

Assessment package ID

target_urlstring

URL to redirect user to after assessment

status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
referencestring

ATS-specific reference ID

application_idstring

ATS application ID

job_idstring

ATS job ID

company_idstring

ATS company ID (reference to AtsCompany)

candidate_idstring

ATS candidate ID

employee_idstring

ATS employee ID

profile_namestring
profile_first_namestring
profile_last_namestring
profile_resume_urlstring
profile_ip_addressstring

XXX.XXX.XXX.XXX

profile_date_of_birthstring

YYYY-MM-DD

profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
profile_emailsstring[]
profile_telephonesstring[]
profile_national_identifierstring
profile_social_media_urlsstring[]
response_completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_expires_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_issued_atstring date-time

Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
response_scorenumber

Assessment score (e.g., 0-100)

response_max_scorenumber

Maximum possible score

response_urlstring

URL to view detailed results

response_redirect_urlstring

URL to redirect the user to complete assessment

response_download_urlsstring[]

Report download URLs

response_sourcestring
rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.