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

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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.
CustomLabels	Custom labels associated with the element.	Collection of Itsolutions.Itslearning.Web.RestApi.Personal.Element.Responses.CustomLabelModel	None.
Terms	The list of terms used in course.	Collection of Itsolutions.Itslearning.Web.Areas.Elements.Models.SelectItem	None.
Categories	The list of assessment record categories used in course.	Collection of Itsolutions.Itslearning.Web.Areas.Elements.Models.SelectItem	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
      }
    ],
    "UseSimpleStatus": 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
      }
    ]
  },
  "CustomLabels": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Color": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Color": "sample string 4"
    }
  ],
  "Terms": [
    {
      "Value": 1,
      "Name": "sample string 2"
    },
    {
      "Value": 1,
      "Name": "sample string 2"
    }
  ],
  "Categories": [
    {
      "Value": 1,
      "Name": "sample string 2"
    },
    {
      "Value": 1,
      "Name": "sample string 2"
    }
  ]
}

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>
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.Areas.Elements.Models">
    <d2p1:SelectItem>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>1</d2p1:Value>
    </d2p1:SelectItem>
    <d2p1:SelectItem>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>1</d2p1:Value>
    </d2p1:SelectItem>
  </Categories>
  <CustomLabels>
    <CustomLabelModel>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </CustomLabelModel>
    <CustomLabelModel>
      <Color>sample string 4</Color>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </CustomLabelModel>
  </CustomLabels>
  <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>
    <d2p1:UseSimpleStatus>true</d2p1:UseSimpleStatus>
  </StatusScale>
  <Terms xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.Areas.Elements.Models">
    <d2p1:SelectItem>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>1</d2p1:Value>
    </d2p1:SelectItem>
    <d2p1:SelectItem>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>1</d2p1:Value>
    </d2p1:SelectItem>
  </Terms>
</ElementSettingsResponse>