Eligibility Model resource

Methods

  • post - Create a new eligibility record.
  • put - Update an existing candidate's eligibility record.

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",
    "eligibility_end_date": "string",
    "portion_codes": [
        "string"
    ],
    "registration_mode": "string",
    "schedule_start_date": "string",
    "test_code": "string",
    "voucher_codes": [
        "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
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
portion_codes[] array of string

A test contains one or more portions. A portion code is the code provided by the client for the portion. No portion code needs to be specified for single portion test. One or more portions must be specified for mult-portion tests.

 Optional
registration_mode string

Mode of registration like Online, Phone, Walkin, Import, Mail, Email, Fax, IVR, ExpressMail, VoiceResponse and Application.

 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
test_code string

The client specific test code for the eligibility to be created against. Allows string values (numeric, alphabets. hyphen and ) upto 50 characters
voucher_codes[] array of string

A comma separated list of voucher code strings. Voucher Codes are pre-agreed discount codes between PSI and the customer.

 Optional