GET api/StudentServices/GetAssignmentDetails?ConsumerKey={ConsumerKey}&UserName={UserName}&AssignmentId={AssignmentId}&cultureTag={cultureTag}

GET request to get the status and launch URL for an assignment ID. Assignment IDs come from the "api/StudentServices/AssignContent" endpoint.

Request Information

URI Parameters

Name	Description	Type	Additional information
ConsumerKey	Consumer Key assigned to the testing center that the student will be associated with for reporting purposes.	string	Required
UserName	Student Username that the assignment was originally assigned to.	string	Required
AssignmentId	AssignmentId returned by the ContentAssignment endpoint	integer	Required
cultureTag		string	Default value is en-US

Body Parameters

None.

Response Information

Resource Description

AssignmentSuccess

Name	Type	Additional information
Assignment	Assignment	None.
Successful	boolean	None.
MsgSuccess	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Assignment": {
    "AssignmentId": 1,
    "ExpirationDate": "2025-05-08T13:21:17.3570562-07:00",
    "Score": 3.0,
    "AccessURL": "sample string 4",
    "Resource": {
      "Key": "sample string 1",
      "Name": "sample string 2",
      "Type": 3,
      "TypeName": "sample string 4"
    },
    "StudentStatus": {
      "Status": 1,
      "StatusName": "Finished"
    },
    "CultureTag": "sample string 5"
  },
  "Successful": true,
  "MsgSuccess": "sample string 2"
}

application/xml, text/xml

Sample:

<AssignmentSuccess xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServices.Repositories.Response">
  <MsgSuccess>sample string 2</MsgSuccess>
  <Successful>true</Successful>
  <Assignment>
    <AccessURL>sample string 4</AccessURL>
    <AssignmentId>1</AssignmentId>
    <CultureTag>sample string 5</CultureTag>
    <ExpirationDate>2025-05-08T13:21:17.3570562-07:00</ExpirationDate>
    <Resource>
      <Key>sample string 1</Key>
      <Name>sample string 2</Name>
      <Type>3</Type>
      <TypeName>sample string 4</TypeName>
    </Resource>
    <Score>3</Score>
    <StudentStatus>
      <Status>1</Status>
    </StudentStatus>
  </Assignment>
</AssignmentSuccess>