PUT /administrator/restfulsimplifiedrelatedstudentkeyvalue/id

Update a related student key value.

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

Request

Example

PUT /administrator/restfulsimplifiedrelatedstudentkeyvalue/id

{
    relatedstudent: 15,
    application: "My example value",
    value: "myvalue",
    student_can_read: true,
    key: "My example value"
}

Required request parameters encoded in the URL

id

The unique identifier of a related student key value 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.

relatedstudent

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

application

Actual location of the field:
devilry.apps.core.models.relateduser.RelatedStudentKeyValue
About the field:
Application identifier. Max 300 chars.
Type
String

value

Actual location of the field:
devilry.apps.core.models.relateduser.RelatedStudentKeyValue
About the field:
Value.
Type
String

student_can_read

Actual location of the field:
devilry.apps.core.models.relateduser.RelatedStudentKeyValue
About the field:
Specifies if a student can read the value or not.
Type
Boolean

key

Actual location of the field:
devilry.apps.core.models.relateduser.RelatedStudentKeyValue
About the field:
Key. Max 300 chars.
Type
String

Response

On success

Example

200 OK

{
    relatedstudent: 15,
    application: "My example value",
    value: "myvalue",
    student_can_read: true,
    key: "My example value",
    id: 15
}

Success response details

As long as the related student key value 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.