Add candidates to existing schedule extended

POST /api/v1/integrations/schedule/add-candidates

Before using this API you need to log into authoring tool and schedule assessment. An schedule has a field ScheduleExtID. You should use this ScheduleExtId in this request.
## Header

Name	Data Type	Description
Content-type:	application/json	for all requests
Authorization:	EAPI {token}	for all requests

Request Parameters

Parameters indicated with a * are mandatory

Name	Data Type	Description
Schedule*	Object	Contains schedule information A timed planning/booking to take an assessment / exam
Schedule.ScheduleExtId	string (64)	Alphanumeric Dashes Every time a new request is made to API this ScheduleExtID must be unique. If you provide a ScheduleExtID that was already passed or an error will occur “Bad request”.
Schedule.GroupExtId*	string (64)	Alphanumeric Dashes When/if adding users, they will be added to the Hierarchy (group) in Cirrus
Schedule.GroupName*	string (500)	When/if adding users, they will be added to the Hierarchy Group title (name) in Cirrus
Candidates*	array	Contains an array of candidates to be scheduled
Candidates[].UserName	string(500)	If not set Candidate UserName = CandidateExtId
Candidates[].CandidateExtId*	string (500)	Alphanumeric Dashes User ID in Cirrus
Candidates[].FirstName*	string (500)	First name user
Candidates[].LastName*	string (500)	Last name user
Candidates[].Email*	string (500)	A valid email
Candidates[].Password	string (500)	If provided can be used for manual logging into system as candidate. The password is salted, hashed and stored in database.
Candidates[].SpecialNeeds	string (500)	true or false Defines if a Candidate has special needs and requires extra time for schedule
Candidates[].ReasonableAdjustmentPercentage	int	Setup a % to add extra time, for example 20% on 60 min will result in 12 min extra time. Parameter can only be sent if SpecialNeeds=true
Candidates[].Photo	string (500)	Any string
Candidates[].Company	string (500)	Any string
Candidates[].City	string (500)	Any string
Candidates[].State	string (500)	Any string
Candidates[].CountryCode	string (500)	Any string
Candidates[].PostalCode	string (500)	Any string
Candidates[].AddressLine1	string (500)	Any string
Candidates[].AddressLine2	string (500)	Any string
Candidates[].PhoneNumber	string (500)	Any string
Candidates[].RegistrationNumber	string (500)	Any string
Candidates[].VoucherId	string (500)	Any string
Candidates[].CompId	string (500)	Any string
Candidates[].ProctorUIds	Array of strings	["1235", "234"]

Request Parameters (for message body)

Parameters indicated with a * are mandatory

Parameter	Type	Description	max length
Array*	String	External ids of invigilators

Sample Body Request

{
	"Schedule": {
		"ScheduleExtId": "ScEXT1",
		"GroupExtId": "GrEXT1",
		"GroupName": "Group_ext_1"
	},
	"Candidates": [
		{
			"CandidateExtId": "EXT1",
			"FirstName": "John",
			"LastName": "Doe",
			"Email": "john.doe@gmail.com"
		}	
	]
}

Sample successfull Response

{
    "Result": "Candidates were successfully added to schedule [ScEXT1]",
    "Schedule": {
        "ScheduleExtId": "ScEXT1",
        "GroupName": "Group_ext_1",
        "GroupExtId": "GrEXT1"
    },
    "Candidates": [
        {
            "CandidateExtId": "EXT1",
            "FirstName": "John",
            "LastName": "Doe",
            "Email": "john.doe@gmail.com",
            "Password": null,
            "StartupLink": "/delivery/external-login?session=1B0D6672709E4786AAA348D48C0F67F1A2D326F6A08C401194473DD32C78D472"
        }
    ]
}