Event scheduling integration

user {
user {userName (string),
firstName (string, optional),
middleName (string, optional),
lastName (string, optional),
dateOfBirth (string, optional),
gender (string, optional),
expiry (string, optional),
addressLine1 (string, optional),
addressLine2 (string, optional),
town (string, optional),
county (string, optional),
country (string, optional),
postCode (string, optional),
email (string, optional),
phone (string, optional),
centres (Array[baseResource], optional),
tests (Array[baseResource], optional),
href (string, optional),
id (integer, optional),
reference (string)
}

• GET (All) – Gets a list of users. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• POST (New User) – Creates a new user that does not already exist.
• GET (by Id) – Returns a single user that matches a specified ID.
• PUT (by Id) – Updates a single user by a known ID.

candidate {
firstName (string),
middleName (string, optional),
lastName (string),
dateOfBirth (string),
uln (string, optional),
gender (string),
expiry (string, optional),
addressLine1 (string, optional),
addressLine2 (string, optional),
town (string, optional),
countyID (string, optional),
countryID (string, optional),
postCode (string, optional),
email (string, optional),
phone (string, optional),
retired (boolean, optional),
centres (Array[baseResource]),
tests (Array[baseResource]),
href (string, optional),
id (integer, optional),
reference (string)
}

• GET (All) – Gets a list of candidates. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• GET (By Id) – Returns a single candidate that matches a specified ID.
• POST (New Candidate) – Creates a new candidate that does not already exist.
• PUT (Updated Candidate) – Updates an existing candidate by ID.
• DELETE (By Id) – Retires the candidate by ID.

test {
name (string, optional),
testpackages (Array[baseResource], optional),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

• GET (All) – Gets a list of tests. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• GET (By Id) – Returns a single test that matches a specified ID.

testpackage {
name (string, optional),
components (Array[baseResource], optional)
}

• GET (All) – Gets a list of test packages. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• GET (By Id) – Returns a single test package that matches a specified ID.

component {
name (string, optional),
type (string, optional),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

• GET (All) – Gets a list of components. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• GET (By Id) – Returns a single component that matches a specified ID.

centre {
name (string),
addressLine1 (string),
addressLine2 (string, optional),
town (string),
county (string),
country (string),
postCode (string, optional),
tests (Array[baseResource]),
centreAdminUser (baseResource),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

• GET (All) – Gets a list of centres. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• GET (By Id) – Returns a single centre that matches a specified ID.
• POST (New Candidate) – Creates a new centre that does not already exist.
• PUT (Updated Candidate) – Updates an existing centre by ID.
• DELETE (By Id) – Retires the centre by ID.

testschedule {
testPackageId (integer, optional),
testPackage (baseResource),
centre (baseResource),
candidate (baseResource, optional),
candidates (Array[baseResource]),
testPackageDate (string),
extendValidityPeriod (boolean, optional),
roomReference (string, optional),
testSessionId (integer, optional),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

• POST (New Scheduled Candidate) – Creates a series of new enrolments based on a list of candidates and a test package ID.
• DELETE (By Id) – Retires the planned test schedule by ID.

testschedulecomponent {
testScehdule (entityRef, optional),
components (Array[entityRef], optional),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

• POST (Set Test Schedule Component for Schedule ID) – Sets the the components for a scheduled test package. Used to reschedule a single component of a test package when the candidate is required to resit the test. A new version of the test is then randomly selected and allocated.

result {
candidate (baseResource, optional),
testPackage (baseResource, optional),
centre (baseResource, optional),
components (Array[resultComponent], optional),
finalScaleScore (string, optional),
overallCEFRGrade (string, optional),
testPackageCompletionDate (string, optional),
completed (boolean, optional),
voided (boolean, optional),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

resultComponent {
scaleScore (string, optional),
CEFRGrade (string, optional),
dateCompleted (string, optional),
keycode (string, optional),
includedInTotal (boolean, optional),
rawScore (integer, optional),
completed (boolean, optional),
voided (boolean, optional),
name (string, optional),
type (string, optional),
href (string, optional),
id (integer, optional),
reference (string, optional)
}

• GET (All) – Gets a list of results. Supports paging using $top and $skip parameters, sorting using $orderBy parameter and filtering using $filter parameter.
• GET (by Id) – Returns a single result based on a specified candidate’s result ID.