LearningSuiteSyllabusMaterial

LearningSuiteSyllabusMaterial

LearningSuiteSyllabusMaterial

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

Access

Methods

[ Jump to Models ]

Table of Contents

Default

MaterialService

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
  • application/xml

Responses

200

Success String

MaterialService

Up 
post /
Create new syllabus material (createSyllabusMaterial)
Create new syllabus material

Return type

MaterialRequest

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

201

Service request is OK and syllabus material has been created MaterialRequest

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 syllabus material (deleteSyllabusMaterial)
Delete syllabus material

Path parameters

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

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
  • application/xml

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}/includeBooklist/{boolean}
Get material by courseID and Booklist (getByCourseIDBooklist)
Get material by courseID and Booklist

Path parameters

courseID (required)
Path Parameter x2014; Identification of the course
boolean (required)
Path Parameter x2014; true or false

Return type

MaterialResponse

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "id" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

200

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

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}
Get material by ID (getByID)
Get material by ID

Path parameters

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

Return type

MaterialResponse

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "id" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

200

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

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/{materialID}
Get material by materialID (getByMaterialID)
Get material by materialID

Path parameters

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

Return type

MaterialResponse

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "id" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

200

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

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 /syllabusID/{syllabusID}
Get material by syllabusID (getBySyllabusID)
Get material by syllabusID

Path parameters

syllabusID (required)
Path Parameter x2014; Identification of the syllabus

Return type

MaterialResponse

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "id" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

200

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

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 /syllabusID/{syllabusID}/includeBooklist/{boolean}
Get material by syllabusID and booklist (getBySyllabusIDBooklist)
Get material by syllabusID and booklist

Path parameters

syllabusID (required)
Path Parameter x2014; Identification of the syllabus
boolean (required)
Path Parameter x2014; true or false

Return type

MaterialResponse

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "id" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

200

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

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 syllabus material (modifySyllabusMaterial)
Modify syllabus material

Path parameters

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

Return type

MaterialRequest

Example data

Content-Type: application/json
{  "image" : "aeiou",  "author" : "aeiou",  "isbn" : "aeiou",  "link" : "aeiou",  "usedPrice" : "aeiou",  "displayOrder" : 123,  "edition" : "aeiou",  "description" : "aeiou",  "title" : "aeiou",  "newPrice" : "aeiou",  "required" : true,  "vendor" : "aeiou",  "syllabusID" : "aeiou",  "publisher" : "aeiou",  "publishedDate" : "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
  • application/xml

Responses

200

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

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

Models

[ Jump to Methods ]

Table of Contents

  1. MaterialRequest
  2. MaterialResponse

MaterialRequest - Up

syllabusID (optional)
String
title (optional)
String
author (optional)
String
publisher (optional)
String
publishedDate (optional)
String
isbn (optional)
String
edition (optional)
String
required (optional)
Boolean
description (optional)
String
image (optional)
String
link (optional)
String
newPrice (optional)
String
usedPrice (optional)
String
vendor (optional)
String
displayOrder (optional)
Integer

MaterialResponse - Up

id (optional)
String
syllabusID (optional)
String
title (optional)
String
author (optional)
String
publisher (optional)
String
publishedDate (optional)
String
isbn (optional)
String
edition (optional)
String
required (optional)
Boolean
description (optional)
String
image (optional)
String
link (optional)
String
newPrice (optional)
String
usedPrice (optional)
String
vendor (optional)
String
displayOrder (optional)
Integer
Service Path: 
/domains/legacy/syllabus/material
Domain or University API: 
D
Tags: 
domains
legacy
syllabus
material

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access