LSAPIAssignmentsAssignment

LSAPIAssignmentsAssignment

Accesses Resources in the Learning Suite course management system
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/learningsuite/assignments/assignment
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AssignmentService

AssignmentService

Up
post /
Create assignment (createAssignment)
Create assignment

Request body

postBody PostBody (required)
Body Parameter x2014; Body to create an assignment

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

201

Service request is OK and an assignment has been created. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
delete /{assignmentID}
Delete assignment (deleteAssignment)
Delete assignment

Path parameters

assignmentID (required)
Path Parameter x2014; individual identification of assignment

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /{assignmentID}
Get assignment by ID (getByAssignmentID)
Get assignment by ID

Path parameters

assignmentID (required)
Path Parameter x2014; individual identification of assignment

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /courseID/{courseID}
Get assignments by courseID (getByCourseID)
Get assignments by courseID

Path parameters

courseID (required)
Path Parameter x2014; Identification of course

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. String

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /courseID/{courseID}/beginDate/{beginDate}
get assignment by courseID and begin date (getByCourseIDBeginDate)
get assignment by courseID and begin date

Path parameters

courseID (required)
Path Parameter x2014; Identification of course
beginDate (required)
Path Parameter x2014; Date when course began

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /courseID/{courseID}/categoryID/{categoryID}
Get assignment by courseID and categoryID (getByCourseIDCategoryID)
Get assignment by courseID and categoryID

Path parameters

courseID (required)
Path Parameter x2014; Identification of course
categoryID (required)
Path Parameter x2014; Identification of category

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /courseID/{courseID}/start/{startdate}/endDate/{endDate}
Get assignment by courseID, start date and end date (getByCourseIDStartDateEndDate)
Get assignment by courseID, start date and end date

Path parameters

courseID (required)
Path Parameter x2014; Identification of course
startdate (required)
Path Parameter x2014; Date when course began
endDate (required)
Path Parameter x2014; Date when course ends

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /courseID/{courseID}/{type}
Get assignments by courseID and type (getByCourseIDType)
Get assignments by courseID and type

Path parameters

courseID (required)
Path Parameter x2014; Identification of course
type (required)
Path Parameter x2014; determines the type of assignment

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. String

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /gbAssignmentID/{gbAssignmentID}
Get by gradebook assignment ID (getByGBAssignmentID)
Get by gradebook assignment ID

Path parameters

gbAssignmentID (required)
Path Parameter x2014; Identifier of the gradebook

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /instructorID/{instructorID}
Get assignments by instructor (getByInstructor)
Get assignments by instructor

Path parameters

instructorID (required)
Path Parameter x2014; Identification of instructor

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /onlineSubmission/{type}/courseID/{courseID}
Get by online Submission (getByOnlineSubmission)
Get by online submission

Path parameters

courseID (required)
Path Parameter x2014; Identification of course
type (required)
Path Parameter x2014; determines the type of assignment

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /rubric/{rubricID}
Get assignment by rubric (getByRubric)
Get assignment by rubric

Path parameters

rubricID (required)
Path Parameter x2014; Identification of the rubric

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /zeroScoresDate/{Date}
Get by zero scores date (getByZeroScoresDate)
Get by zero scores date

Path parameters

Date (required)
Path Parameter x2014; The date all scores have to be submitted

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
put /{assignmentID}
Modify assignment (modifyAssignment)
Modify assignment

Path parameters

assignmentID (required)
Path Parameter x2014; individual identification of assignment

Request body

putBody PostBody (required)
Body Parameter x2014; Body to modify an assignment

Return type

Example data

Content-Type: application/json
{  "visibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "dueDate" : 1.3579000000000001069366817318950779736042022705078125,  "allowScoreDrop" : true,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "passingScore" : 1.3579000000000001069366817318950779736042022705078125,  "rubric" : "aeiou",  "displayOrderCalendar" : 1.3579000000000001069366817318950779736042022705078125,  "type" : "aeiou",  "points" : 1.3579000000000001069366817318950779736042022705078125,  "onlineSubmission" : "aeiou",  "displayOrderCalendarBegin" : 1.3579000000000001069366817318950779736042022705078125,  "typeID" : "aeiou",  "graded" : true,  "categoryID" : "aeiou",  "extraCredit" : true,  "minScore" : 1.3579000000000001069366817318950779736042022705078125,  "includeScoreInFinalGrade" : true,  "weight" : 1.3579000000000001069366817318950779736042022705078125,  "scoreVisibleDate" : 1.3579000000000001069366817318950779736042022705078125,  "url" : "aeiou",  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "multipleFileSubmission" : "aeiou",  "postBody" : {    "visible" : true,    "modifiedDate" : 1.3579000000000001069366817318950779736042022705078125,    "modifiedBy" : "aeiou",    "ownerID" : "aeiou",    "title" : "aeiou",    "creationDate" : 1.3579000000000001069366817318950779736042022705078125,    "courseID" : "aeiou"  },  "scoreEntry" : "aeiou",  "name" : "aeiou",  "gradingScale" : "aeiou",  "allowLateSubmission" : true,  "courseID" : "aeiou",  "passScoreRequired" : true}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Service request is OK and a response has been generated. responseData

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Models

[ Jump to Methods ]

Table of Contents

  1. postBody
  2. responseData

postBody - Up

courseID (optional)
ownerID (optional)
title (optional)
creationDate (optional)
modifiedDate (optional)
modifiedBy (optional)
visible (optional)

responseData - Up

postBody (optional)
courseID (optional)
String 12 digit course
categoryID (optional)
String 12 digit course
type (optional)
String type of assignment
typeID (optional)
String 12 digit course
name (optional)
String 100 char assignment name
description (optional)
String MAX 12000 char description of the assignment
beginDate (optional)
BigDecimal Begin date of assignment
dueDate (optional)
BigDecimal Due date of assignment
points (optional)
BigDecimal MAX 12000 char description of the assignment
weight (optional)
BigDecimal Total number of points that an assignment is worth
extraCredit (optional)
Boolean Is the assignment extra credit
graded (optional)
Boolean Will the assignment be graded
gradingScale (optional)
String The UID of the grading scale associated with the assignment
rubric (optional)
String The UID of the rubric that is associated with this assignment
allowLateSubmission (optional)
Boolean Is allowing late submissions allowed
scoreEntry (optional)
onlineSubmission (optional)
multipleFileSubmission (optional)
allowScoreDrop (optional)
Boolean Will the score be dropped
includeScoreInFinalGrade (optional)
Boolean Is the assignment included in the final grade?
passingScore (optional)
BigDecimal This is the minimum passing score of the assignment
passScoreRequired (optional)
Boolean Is a passing score required
minScore (optional)
BigDecimal The minimum score that can be given
visibleDate (optional)
BigDecimal When the assignment may be visable to the student. In timestamp form
scoreVisibleDate (optional)
BigDecimal When the assignment score may be visible to the student. In timestamp form
displayOrderCalendar (optional)
BigDecimal The order that the assignemnt will be displayed on the calendar page
displayOrderCalendarBegin (optional)
BigDecimal The order that the exam beginDate will be displayed on the calendar page
displayOrder (optional)
BigDecimal The order that the assignment will be displayed on the page
url (optional)
String Unique url identifier within a course for the assignment
Service Path: 
/domains/legacy/learningsuite/assignments/assignment
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!