GET /administrator/restfulsimplifiedrelatedexaminer/id

Retrieve a related examiner.

The underlying data model where the item is retrieved from is defined in devilry.apps.core.models.relateduser.RelatedExaminer. The Simplified API that the server forwards this request to is devilry.apps.administrator.simplified.simplifiedrelatedexaminer.SimplifiedRelatedExaminer.read().

Request

Example

GET /administrator/restfulsimplifiedrelatedexaminer/id

Required request parameters encoded in the URL

id

The unique identifier of a related examiner. You will typically get this id in response from a search.

Response

On success

Example

200 OK

{
    id: 15,
    period: 15,
    user: 15,
    tags: "myvalue",
    user__username: "My example value",
    user__devilryuserprofile__full_name: ["this", "is", "an", "example"],
    user__email: "My example value"
}

Success response details

As long as the related examiner is deleted without an error, the response is HTTP 200 with the requested data in the body. The result always contains the following fields:

id

Actual location of the field:

devilry.apps.core.models.relateduser.RelatedExaminer

About the field:

Autogenerated identifier.

Type

Integer

period

Actual location of the field:

devilry.apps.core.models.Period

About the field:

Autogenerated identifier.

Type

Integer

user

Actual location of the field:

django.contrib.auth.models.User

About the field:

Autogenerated identifier.

Type

Integer

tags

Actual location of the field:

devilry.apps.core.models.relateduser.RelatedExaminer

About the field:

Comma-separated list of tags. Each tag is a word with the following letters allowed: a-z and 0-9. Each word is separated by a comma, and no whitespace.

Type

String

user__username

Actual location of the field:

django.contrib.auth.models.User

About the field:

Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters

Type

String

user__devilryuserprofile__full_name

Actual location of the field:

devilry.apps.core.models.DevilryUserProfile

About the field:

List of many values.

Type

List of strings

user__email

Actual location of the field:

django.contrib.auth.models.User

About the field:

Type

String

On error

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