LSAPIAssignmentsCategory
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/category
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]Table of Contents
AssignmentService
CategoryService
delete /{categoryID}get /graded/{true|false}get /agilixCategoryID/{agilixCategoryID}get /calendarOnly/{true|false}get /courseID/{courseID}get /courseID/{courseID}/title/{title}get /{categoryID}put /{categoryID}
AssignmentService
Up
post /Create category (create category)
Create category
Request body
postBody PutBody (required)
Body Parameter x2014; Body required to create a category
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
204
Service request is OK and category has been created. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. StringCategoryService
Up
delete /{categoryID}Delete category (deleteCategory)
Delete category
Path parameters
categoryID (required)
Path Parameter x2014; Identification of the category
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. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
get /graded/{true|false}Get categories by graded status (get ByGradedStatus)
Get categories by graded status
Path parameters
true|false (required)
Path Parameter x2014; true or false
Return type
Example data
Content-Type: application/json
{ "percentDecimals" : "aeiou", "lsCategoryID" : "aeiou", "displayOrder" : 1.3579000000000001069366817318950779736042022705078125, "weight" : 1.3579000000000001069366817318950779736042022705078125, "viewLetterGrade" : true, "lowScoresToDrop" : 1.3579000000000001069366817318950779736042022705078125, "pointsDecimals" : "aeiou", "gbCategoryID" : "aeiou", "title" : "aeiou", "viewPoints" : true, "calendarOnly" : "aeiou", "viewPercent" : true, "equalAssignWeight" : true, "graded" : true, "id" : "aeiou", "courseID" : "aeiou", "headingID" : "aeiou", "extraCredit" : 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. getResponse400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
get /agilixCategoryID/{agilixCategoryID}get categories by agilix categoryID (getByAgilixCategoryID)
get categories by agilix categoryID
Path parameters
agilixCategoryID (required)
Path Parameter x2014; Identification of the agilix categoryID
Return type
Example data
Content-Type: application/json
{ "percentDecimals" : "aeiou", "lsCategoryID" : "aeiou", "displayOrder" : 1.3579000000000001069366817318950779736042022705078125, "weight" : 1.3579000000000001069366817318950779736042022705078125, "viewLetterGrade" : true, "lowScoresToDrop" : 1.3579000000000001069366817318950779736042022705078125, "pointsDecimals" : "aeiou", "gbCategoryID" : "aeiou", "title" : "aeiou", "viewPoints" : true, "calendarOnly" : "aeiou", "viewPercent" : true, "equalAssignWeight" : true, "graded" : true, "id" : "aeiou", "courseID" : "aeiou", "headingID" : "aeiou", "extraCredit" : 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. getResponse400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
get /calendarOnly/{true|false}Get categories by calendaronly (getByCalendarOnly)
Get categories by calendaronly
Path parameters
true|false (required)
Path Parameter x2014; true or false
Return type
Example data
Content-Type: application/json
{ "percentDecimals" : "aeiou", "lsCategoryID" : "aeiou", "displayOrder" : 1.3579000000000001069366817318950779736042022705078125, "weight" : 1.3579000000000001069366817318950779736042022705078125, "viewLetterGrade" : true, "lowScoresToDrop" : 1.3579000000000001069366817318950779736042022705078125, "pointsDecimals" : "aeiou", "gbCategoryID" : "aeiou", "title" : "aeiou", "viewPoints" : true, "calendarOnly" : "aeiou", "viewPercent" : true, "equalAssignWeight" : true, "graded" : true, "id" : "aeiou", "courseID" : "aeiou", "headingID" : "aeiou", "extraCredit" : 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. getResponse400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
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 categories by course (getByCourseID)
Get categories by course
Path parameters
courseID (required)
Path Parameter x2014; Identification of the course
Return type
Example data
Content-Type: application/json
{ "percentDecimals" : "aeiou", "lsCategoryID" : "aeiou", "displayOrder" : 1.3579000000000001069366817318950779736042022705078125, "weight" : 1.3579000000000001069366817318950779736042022705078125, "viewLetterGrade" : true, "lowScoresToDrop" : 1.3579000000000001069366817318950779736042022705078125, "pointsDecimals" : "aeiou", "gbCategoryID" : "aeiou", "title" : "aeiou", "viewPoints" : true, "calendarOnly" : "aeiou", "viewPercent" : true, "equalAssignWeight" : true, "graded" : true, "id" : "aeiou", "courseID" : "aeiou", "headingID" : "aeiou", "extraCredit" : 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. getResponse400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
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}/title/{title}Get categories by courseID and title (getByCourseIDTitle)
Get categories by courseID and title
Path parameters
courseID (required)
Path Parameter x2014; Identification of the course
title (required)
Path Parameter x2014; Title of the category
Return type
Example data
Content-Type: application/json
{ "percentDecimals" : "aeiou", "lsCategoryID" : "aeiou", "displayOrder" : 1.3579000000000001069366817318950779736042022705078125, "weight" : 1.3579000000000001069366817318950779736042022705078125, "viewLetterGrade" : true, "lowScoresToDrop" : 1.3579000000000001069366817318950779736042022705078125, "pointsDecimals" : "aeiou", "gbCategoryID" : "aeiou", "title" : "aeiou", "viewPoints" : true, "calendarOnly" : "aeiou", "viewPercent" : true, "equalAssignWeight" : true, "graded" : true, "id" : "aeiou", "courseID" : "aeiou", "headingID" : "aeiou", "extraCredit" : 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. getResponse400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
get /{categoryID}Get category by ID (getByID)
Get category by ID
Path parameters
categoryID (required)
Path Parameter x2014; Identification of the category
Return type
Example data
Content-Type: application/json
{ "percentDecimals" : "aeiou", "lsCategoryID" : "aeiou", "displayOrder" : 1.3579000000000001069366817318950779736042022705078125, "weight" : 1.3579000000000001069366817318950779736042022705078125, "viewLetterGrade" : true, "lowScoresToDrop" : 1.3579000000000001069366817318950779736042022705078125, "pointsDecimals" : "aeiou", "gbCategoryID" : "aeiou", "title" : "aeiou", "viewPoints" : true, "calendarOnly" : "aeiou", "viewPercent" : true, "equalAssignWeight" : true, "graded" : true, "id" : "aeiou", "courseID" : "aeiou", "headingID" : "aeiou", "extraCredit" : 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. getResponse400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
put /{categoryID}Modify category (modifyCategory)
Modify category
Path parameters
categoryID (required)
Path Parameter x2014; Identification of the category
Request body
putBody PutBody (required)
Body Parameter x2014; Body required to update a category
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
204
Service request is OK and a response has been generated. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. StringModels
[ Jump to Methods ]Table of Contents
getResponse - Up
courseID (optional)
String 12 digit course UID
headingID (optional)
String 12 digit course UID
title (optional)
String Category title MAX 45 chars
weight (optional)
BigDecimal The weight of the category
equalAssignWeight (optional)
Boolean Will each assignment in the category have an equal weight
lowScoresToDrop (optional)
BigDecimal Number of low scores to drop
extraCredit (optional)
Boolean Is the category extra credit
viewPoints (optional)
Boolean Will the students be able to see the points
viewPercent (optional)
Boolean Will the students be able to see the percent
pointsDecimals (optional)
String How many decimal places to show when viewing scores as points
percentDecimals (optional)
String How many decimal places to show when viewing scores as percentages
viewLetterGrade (optional)
Boolean Will the students be able to see the letter grade
lsCategoryID (optional)
String Deprecated
gbCategoryID (optional)
displayOrder (optional)
BigDecimal The display order of the categories on the page
graded (optional)
Boolean Is the category graded
calendarOnly (optional)
String Whether the category exists only for the calendar or not
id (optional)
String The unique identifier of the resource
putBody - Up
courseID (optional)
headingID (optional)
title (optional)
weight (optional)
equalAssignWeight (optional)
lowScoresToDrop (optional)
extraCredit (optional)
viewPoints (optional)
viewPercent (optional)
viewLetterGrade (optional)
agilixCategoryID (optional)
displayOrder (optional)
graded (optional)
calendarOnly (optional)
Service Path:
/domains/legacy/learningsuite/assignments/category
Domain or University API:
D
