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

Get settings for an assignment. This includes assessment scale (if used), and assessment status (if used).

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

Settings for the assignment

Itsolutions.Itslearning.Web.RestApi.Personal.Element.Responses.ElementSettingsResponse
NameDescriptionTypeAdditional information
StatusScale

The assessment status which is used to set a status item on an answer (submission). Can be null if no assessment status is defined for the element.

Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.StatusScale

None.

AssessmentScale

The assessment scale which is used to set a grade on an answer (submission). Can be null if no assessment scale is defined for the element.

Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.AssessmentScale

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusScale": {
    "AssessmentStatusId": 1,
    "Title": "sample string 2",
    "Description": "sample string 3",
    "StatusItems": [
      {
        "AssessmentStatusItemId": 1,
        "Title": "sample string 2",
        "IsEditable": true,
        "IsCompleted": true,
        "IsSubmitted": true,
        "IsInitialStatus": true
      },
      {
        "AssessmentStatusItemId": 1,
        "Title": "sample string 2",
        "IsEditable": true,
        "IsCompleted": true,
        "IsSubmitted": true,
        "IsInitialStatus": true
      }
    ]
  },
  "AssessmentScale": {
    "AssessmentId": 1,
    "Title": "sample string 2",
    "Description": "sample string 3",
    "AssessmentItems": [
      {
        "AssessmentItemId": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "PercentTo": 4.1,
        "PercentFromAndIncl": 5.1
      },
      {
        "AssessmentItemId": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "PercentTo": 4.1,
        "PercentFromAndIncl": 5.1
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ElementSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Responses">
  <AssessmentScale xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:AssessmentId>1</d2p1:AssessmentId>
    <d2p1:AssessmentItems>
      <d2p1:AssessmentItem>
        <d2p1:AssessmentItemId>1</d2p1:AssessmentItemId>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:PercentFromAndIncl>5.1</d2p1:PercentFromAndIncl>
        <d2p1:PercentTo>4.1</d2p1:PercentTo>
        <d2p1:Title>sample string 2</d2p1:Title>
      </d2p1:AssessmentItem>
      <d2p1:AssessmentItem>
        <d2p1:AssessmentItemId>1</d2p1:AssessmentItemId>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:PercentFromAndIncl>5.1</d2p1:PercentFromAndIncl>
        <d2p1:PercentTo>4.1</d2p1:PercentTo>
        <d2p1:Title>sample string 2</d2p1:Title>
      </d2p1:AssessmentItem>
    </d2p1:AssessmentItems>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Title>sample string 2</d2p1:Title>
  </AssessmentScale>
  <StatusScale xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:AssessmentStatusId>1</d2p1:AssessmentStatusId>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:StatusItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Responses">
      <d3p1:StatusItem>
        <d3p1:AssessmentStatusItemId>1</d3p1:AssessmentStatusItemId>
        <d3p1:IsCompleted>true</d3p1:IsCompleted>
        <d3p1:IsEditable>true</d3p1:IsEditable>
        <d3p1:IsInitialStatus>true</d3p1:IsInitialStatus>
        <d3p1:IsSubmitted>true</d3p1:IsSubmitted>
        <d3p1:Title>sample string 2</d3p1:Title>
      </d3p1:StatusItem>
      <d3p1:StatusItem>
        <d3p1:AssessmentStatusItemId>1</d3p1:AssessmentStatusItemId>
        <d3p1:IsCompleted>true</d3p1:IsCompleted>
        <d3p1:IsEditable>true</d3p1:IsEditable>
        <d3p1:IsInitialStatus>true</d3p1:IsInitialStatus>
        <d3p1:IsSubmitted>true</d3p1:IsSubmitted>
        <d3p1:Title>sample string 2</d3p1:Title>
      </d3p1:StatusItem>
    </d2p1:StatusItems>
    <d2p1:Title>sample string 2</d2p1:Title>
  </StatusScale>
</ElementSettingsResponse>