LearningSuiteCourseBuilderMaterial

LearningSuiteCourseBuilderMaterial

CourseBuilderMaterialService
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/learningsuite/coursebuilder/material
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

CourseBuilderMaterialService

Default

CourseBuilderMaterialService

Up
post /
Create a new material item (createMaterialItem)
Create a new material item

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

201

Service request is OK and a course has been created 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
delete /{materialID}
Delete material (deleteByMaterialID)
Delete material

Path parameters

materialID (required)
Path Parameter x2014; Identification of the material item

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}
returns information for a specific course (getByCourse)
Returns information for a specific course

Path parameters

courseID (required)
Path Parameter x2014; Identification of the specific 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 /{materialID}
Retrieves information about a single material item by material ID (getByMaterialID)
Retrieves information about a single material item by material ID

Path parameters

materialID (required)
Path Parameter x2014; Identification of the material item

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
put /{materialID}
Modify values of an existing material (modifybyMaterialID)
Modify values of an existing material

Path parameters

materialID (required)
Path Parameter x2014; Identification of the material item

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

Default

Up
get /documentation
service definition (getServiceDocumentation)
service definition

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

Success String

Models

[ Jump to Methods ]

Table of Contents

Service Path: 
/domains/legacy/learningsuite/coursebuilder/material
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!