Retrieve a candidate.
The underlying data model where the item is retrieved from 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.read().
200 OK
{
student: 15,
candidate_id: "My example value",
id: 15,
identifier: "My example value",
full_name: "My example value",
email: "My example value",
assignment_group: 15
}
As long as the candidate is deleted without an error, the response is HTTP 200 with the requested data in the body. The result always contains the following fields:
- student
- Actual location of the field:
- django.contrib.auth.models.User
- About the field:
- Autogenerated identifier.
- Type
- Integer
- 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
- id
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- Autogenerated identifier.
- Type
- Integer
- identifier
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- The candidate_id if this is a candidate on an anonymous assignment, and username if not.
- Type
- String
- full_name
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- None if this is a candidate on an anonymous assignment, and full name if not.
- Type
- String
- Actual location of the field:
- devilry.apps.core.models.Candidate
- About the field:
- None if this is a candidate on an anonymous assignment, and email address if not.
- Type
- String
- assignment_group
- Actual location of the field:
- devilry.apps.core.models.AssignmentGroup
- About the field:
- Autogenerated identifier.
- Type
- Integer
On errors, we respond with one of the HTTP Error status codes.