PUT /administrator/restfulsimplifiedcandidate/id

Update a candidate.

The underlying data model where the item is updated is defined in devilry.apps.core.models.Candidate. The Simplified API that the server forwards this request to is devilry.apps.administrator.simplified.simplifiedcandidate.SimplifiedCandidate.update().

Request

Example

PUT /administrator/restfulsimplifiedcandidate/id

{
    candidate_id: "My example value",
    student: 15,
    assignment_group: 15
}

Required request parameters encoded in the URL

id

The unique identifier of a candidate as the last item in the URL. You will typically get this id in response from a search.

Required request parameters

The following request parameters are encoded as a JSON object and sent as the request body as shown in the example above.

candidate_id

Actual location of the field:
devilry.apps.core.models.Candidate
About the field:
An optinal candidate id. This can be anything as long as it is less than 30 characters.
Type
String

student

Actual location of the field:
django.contrib.auth.models.User
About the field:
Autogenerated identifier.
Type
Integer

assignment_group

Actual location of the field:
devilry.apps.core.models.AssignmentGroup
About the field:
Autogenerated identifier.
Type
Integer

Response

On success

Example

200 OK

{
    candidate_id: "My example value",
    student: 15,
    assignment_group: 15,
    id: 15
}

Success response details

As long as the candidate is updated without an error, the response is HTTP 201 with the requested data in the body. The result always contains the data you sent in to the update method, however some values may have been changed due to logic performed on the server before saving.

On error

On errors, we respond with one of the HTTP Error status codes.