Existing Eligiblity Model resource

Methods

  • get - Get the eligibilities associated with the candidate id for the specific status (status is the query parameter).
  • get - Get the eligibilities associated with the candidate id for the specific test code.
  • get - Get the eligibility records for a candidate.

Resource

{
    "candidate": {
        "additional_attributes": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "address1": "string",
        "address2": "string",
        "candidate_id": "string",
        "city": "string",
        "country": "string",
        "email": "string",
        "first_name": "string",
        "home_phone": "string",
        "last_name": "string",
        "middle_name": "string",
        "office_phone": "string",
        "postal_code": "string",
        "province_state": "string",
        "school_code": "string",
        "special_accommodations": [
            "string"
        ],
        "suffix": "string"
    },
    "client_eligibility_id": "string",
    "created_datetime": "string",
    "eligibility_end_date": "string",
    "eligibility_status_message": "string",
    "eligible_to_schedule": "boolean",
    "portion_codes": [
        "string"
    ],
    "psi_eligiblity_id": "string",
    "schedule_start_date": "string",
    "status": "string",
    "test_code": "string"
}

Properties

Name Type Description Additional
candidate object Candidate Model
candidate.additional_attributes[] array Optional
candidate.additional_attributes[].key string

The key agreed upon by PSI and the client in advanced to store a custom candidate attribute.

 Optional
candidate.additional_attributes[].value string

The vlaue of the additional attribute.

 Optional
candidate.address1 string Optional
candidate.address2 string Optional
candidate.candidate_id string

The supplied candidates unique id.
candidate.city string Optional
candidate.country string

2 digit country code per ISO 3166-1 alpha-2 standards.

 Optional
candidate.email string Optional
candidate.first_name string
candidate.home_phone string Optional
candidate.last_name string
candidate.middle_name string Optional
candidate.office_phone string Optional
candidate.postal_code string

Candidates zip code, postal code or equivilent.

 Optional
candidate.province_state string

The canidates province, state or equivilent. Must be 2 digit state abbrevation for USA

 Optional
candidate.school_code string

If supplied, the list of school codes must be added to PSI's system in advance of the import.

 Optional
candidate.special_accommodations[] array of string

If supplied, the list of special accommodation codes must be added to PSI's system in advance of the import.

 Optional
candidate.suffix string Optional
client_eligibility_id string

A unique identifier for this eligibility in the client system, when provided with eligibility data. PSI system currently accepts 20 characters of alphanumerics, hyphen, dot, and underscore for this field.

 Optional
created_datetime string

Datetime when the eligibility was created. Must be a DateTime value in UTC specified as YYYY-MM-DDThh:mm:ssZ (ISO-8601 format).
e.g. Apr 1, 20202 10 pm in UTC will be represented as 2020-04-01T22:00:00Z.

 Optional
eligibility_end_date string

The last date possible for the candidate to schedule on. Must be a DateTime value in UTC specified as YYYY-MM-DDThh:mm:ssZ (ISO-8601 format).
e.g. Apr 1, 20202 10 pm in UTC will be represented as 2020-04-01T22:00:00Z.

 Optional
eligibility_status_message string

Any pertinent message about why a candidate is not eligibile to scheduled yet. Common reasons can be because they have been blocked, have pending special accommodations or other similar reasons. Must be null if candidate is eligible to schedule.

 Optional
eligible_to_schedule boolean

Whether or not this candidate is eligibile to be scheduled.

 Optional
portion_codes[] array of string

A test contains one or more portions. A portion code is a unique alphanumeric identifier for the portion generally 8 characters long. No portion code needs to be specified for single portion test. One or more portions must be specified for mult-portion tests.

 Optional
psi_eligiblity_id string

A 8 characters unique alphanumeric identifier for this eligibility generated by PSI.

 Optional
schedule_start_date string

The first date possible for the candidate to schedule on. Must be a DateTime value in UTC specified as YYYY-MM-DDThh:mm:ssZ (ISO-8601 format).
e.g. Apr 1, 20202 10 pm in UTC will be represented as 2020-04-01T22:00:00Z.

 Optional
status string

Only set on this object when returned back to client. Setting this has no effect when provided as part of a create or update.

This field is an indicative of current status of the eligibility record in PSI side.

  • Until candidate has never scheduled for this eligibility record, statuses available for a candidate are:
    • REG01 - Registration Pending(Subjective to availability for a customer program)
    • REG02 - Registration approved
    • REG03 - Cancelled
  • Once candidate has scheduled this eligibility to take exam, statuses available for a candidate are:
    • CSS1 - Scheduled for Test
    • CSS2 - Schedule cancelled
    • CSS5 - Test Schedule Completed
    • CSS8 - Absent for the Test
    • CSS9 - Excused Absent(Subjective to availability for a customer program)

Possible values are:

  • REG01
  • REG02
  • REG03
  • CSS1
  • CSS2
  • CSS5
  • CSS8
  • CSS9
 Optional
test_code string

The client specific test code for the eligibility to be created against. Allows alphabets, numberic and hyphen '-' for readibility. Max allowed length 50