GET restapi/personal/assignments/{elementId}/v1

Get information about an assignment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
elementId

The elementId for the assignment, unique in scope of a customer.

integer

Required

Body Parameters

None.

Response Information

Resource Description

when request was successful (200 - ok)

403 - Forbidden when user does not have access to the assignment

Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Responses.AssignmentResponse
NameDescriptionTypeAdditional information
ElementId

The unique identifier for the assignment element (which is used in a course) in scope of a customer.

integer

None.

Title

The title of the assignment

string

None.

IsHomework

Defines whether the assignment is a homework assignment.

boolean

None.

Deadline

Deadline for the assignment. If null, there is no deadline.

date

None.

UsePlagiarismCheck

Defines whether answers will be checked for plagiarism. When true there are some restrictions on the files that can be uploaded.

boolean

None.

AssessmentId

The assessment id (grades / assessment scale) used for the assignment, will be null if assessment scale is not used.

integer

None.

IsAssessmentVisibleForStudents

Defines whether the assessment is visible for students.

boolean

None.

SubmissionType

Submission type for the assignment

Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Enums.AssignmentSubmissionType

None.

IsAnonymous

Defines whether submission is anonymous.

boolean

None.

IsSelfAssessmentRequired

Defines whether self-assessment is required.

boolean

None.

PeersToAssessCount

How many other students should each student peer assess. null means that peer assessment is not used.

integer

None.

Text

string

None.

Files

Collection of Itslearning.Applications.Assignment.RestApi.Models.FileModel

None.

AnswerId

integer

None.

CanEditAssignment

True if the user can edit the assignment itself - Text and Files, false otherwise.

boolean

None.

CanEvaluateAnswers

boolean

None.

CanSubmitOrEditAnswer

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ElementId": 1,
  "Title": "sample string 2",
  "IsHomework": true,
  "Deadline": "2025-08-21T17:30:11Z",
  "UsePlagiarismCheck": true,
  "AssessmentId": 1,
  "IsAssessmentVisibleForStudents": true,
  "SubmissionType": "Individual",
  "IsAnonymous": true,
  "IsSelfAssessmentRequired": true,
  "PeersToAssessCount": 1,
  "Text": "sample string 8",
  "Files": [
    {
      "FileRepoId": "sample string 1",
      "Name": "sample string 2",
      "Size": 3,
      "LastModified": "2025-08-21T17:30:11Z",
      "DownloadUrl": "sample string 5",
      "DownloadUrlExpires": "2025-08-21T17:30:11Z"
    },
    {
      "FileRepoId": "sample string 1",
      "Name": "sample string 2",
      "Size": 3,
      "LastModified": "2025-08-21T17:30:11Z",
      "DownloadUrl": "sample string 5",
      "DownloadUrlExpires": "2025-08-21T17:30:11Z"
    }
  ],
  "AnswerId": 1,
  "CanEditAssignment": true,
  "CanEvaluateAnswers": true,
  "CanSubmitOrEditAnswer": true
}

application/xml, text/xml

Sample:
<AssignmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Responses">
  <AnswerId>1</AnswerId>
  <AssessmentId>1</AssessmentId>
  <CanEditAssignment>true</CanEditAssignment>
  <CanEvaluateAnswers>true</CanEvaluateAnswers>
  <CanSubmitOrEditAnswer>true</CanSubmitOrEditAnswer>
  <Deadline>2025-08-21T17:30:11Z</Deadline>
  <ElementId>1</ElementId>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.Applications.Assignment.RestApi.Models">
    <d2p1:FileModel>
      <d2p1:DownloadUrl>sample string 5</d2p1:DownloadUrl>
      <d2p1:DownloadUrlExpires>2025-08-21T17:30:11Z</d2p1:DownloadUrlExpires>
      <d2p1:FileRepoId>sample string 1</d2p1:FileRepoId>
      <d2p1:LastModified>2025-08-21T17:30:11Z</d2p1:LastModified>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Size>3</d2p1:Size>
    </d2p1:FileModel>
    <d2p1:FileModel>
      <d2p1:DownloadUrl>sample string 5</d2p1:DownloadUrl>
      <d2p1:DownloadUrlExpires>2025-08-21T17:30:11Z</d2p1:DownloadUrlExpires>
      <d2p1:FileRepoId>sample string 1</d2p1:FileRepoId>
      <d2p1:LastModified>2025-08-21T17:30:11Z</d2p1:LastModified>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Size>3</d2p1:Size>
    </d2p1:FileModel>
  </Files>
  <IsAnonymous>true</IsAnonymous>
  <IsAssessmentVisibleForStudents>true</IsAssessmentVisibleForStudents>
  <IsHomework>true</IsHomework>
  <IsSelfAssessmentRequired>true</IsSelfAssessmentRequired>
  <PeersToAssessCount>1</PeersToAssessCount>
  <SubmissionType>Individual</SubmissionType>
  <Text>sample string 8</Text>
  <Title>sample string 2</Title>
  <UsePlagiarismCheck>true</UsePlagiarismCheck>
</AssignmentResponse>