NotificationRequest resource

Methods

  • put - Send push based notifications about Booking events (scheduling, rescheduling, cancelling etc) to interested systems.

Resource

{
    "booking_code": "string",
    "booking_on": "string",
    "candidate_fname": "string",
    "candidate_id": "string",
    "candidate_lname": "string",
    "candidate_mname": "string",
    "change_reason": "string",
    "client_eligibility_id": "string",
    "delivery_mode": "string",
    "effective_date": "string",
    "exam_code": "string",
    "exam_portions": [
        {
            "portion_code": "string",
            "portion_name": "string"
        }
    ],
    "location_address": "string",
    "location_code": "string",
    "location_name": "string",
    "location_timezone": "string"
}

Properties

Name Type Description Additional
booking_code string

Alphanumeric unique identifier for this exam appointment (aka appointment ID, confirmation ID)
booking_on string

Date/Time (ISO 8601 format) when the booking starts. The Date/Time value will be in UTC YYYY-MM-DDThh:mm:ssZ
e.g. Apr 1, 20202 10 pm in UTC will be represented as 2020-04-01T22:00:00Z.
candidate_fname string

Candidate first Name
candidate_id string

customer defined Canddiate ID
candidate_lname string

Candidate last Name
candidate_mname string

Candidate middle Name

 Optional
change_reason string

Indicator for the change that fired this event.

Possible values are:

  • BOOKING_CREATED
  • BOOKING_CANCELLED
  • BOOKING_RESCHEDULED
  • EXAM_COMPLETED
  • EXCUSED_ABSENT
  • ABSENT
client_eligibility_id string

Client's unique identifier for this eligibility, if provided.

 Optional
delivery_mode string

Indicator for delivery mode of the schedule.

Possible values are:

  • SITE_PROCTORED
  • ATLAS_REMOTE_PROCTORED
 Optional
effective_date string

Date/Time (ISO 8601 format) when this activity was done in PSI system. The Date/Time value will be in UTC YYYY-MM-DDThh:mm:ssZ.
e.g. Apr 1, 20202 10 pm in UTC will be represented as 2020-04-01T22:00:00Z.

 Optional
exam_code string

Optional field. Alphanumeric unique identifier for this exam as defined in external system

 Optional
exam_portions[] array Optional
exam_portions[].portion_code string

Unique alphanumeric key for this portion

 Optional
exam_portions[].portion_name string

Name of the portion

 Optional
location_address string

Test site Address.
Important: This field is provided only for SITE_PROCTORED exam delivery mode.

 Optional
location_code string

Alphanumeric ID of the test center for this appointment. Available only for SITE_PROCTORED exams.

 Optional
location_name string

Name of the Test site.
Important: This field is provided only for SITE_PROCTORED exam delivery mode.

 Optional
location_timezone string

Timezone value as selected by candidate at the time of booking the exam.

  • For a SITE_PROCTORED delivery, the timezone for the test center site is used
  • For ATLAS_REMOTE_PROCTORED exams the timezone value selected by candidate during scheduling flow is used
  • For all other delivery modes, this field will be empty
PSI stores timezone in country/zone format based on IANA Time Zone database. A timezone value looks like – “Country/zone”. For example US/Eastern Zone is stored as America/New_York. For cases where multiple countires fall under same timezone such as Central European Standard Time, there are multiple values possible that the scheduling flow would use depending upon candidate’s country. Here are few examples:
  • Candidate in France will choose Europe/Paris
  • Candidate in Switzerland will choose Europe/Zurich
  • Candidate in Italy will choose Europe/Rome
  • Candidate in Germany will choose Europe/Berlin

 Optional