SyllabusBuilderSyllabus
This service accesses resources in the Learning Suite.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/syllabusbuilder/syllabus
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]Table of Contents
Default
SyllabusService
Default
Up
get /documentationService definition (getServiceDocumentation)
Service definitions
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/jsonapplication/xml
Responses
200
Success StringSyllabusService
Up
post /Create Syllabus (createSyllabus)
Create syllabus
Return type
Example data
Content-Type: application/json
{ "owner" : "aeiou", "period" : "aeiou", "curriculumID" : "aeiou", "courseID" : "aeiou", "titleCode" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SyllabusRequest400
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
delete /{syllabusID}Delete Syllabus (deleteSyllabus)
Delete syllabus
Path parameters
syllabusID (required)
Path Parameter x2014; Syllabus Identification
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/jsonapplication/xml
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 /courseID/{courseID}Get syllabus by course (getSyllabusByCourse)
Get syllabus by course
Path parameters
courseID (required)
Path Parameter x2014; Course identification
Return type
Example data
Content-Type: application/json
{ "owner" : "aeiou", "period" : "aeiou", "id" : "aeiou", "curriculumID" : "aeiou", "courseID" : "aeiou", "titleCode" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SyllabusResponse400
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 /{syllabusID}Get syllabus by ID (getSyllabusByID)
Get syllabus by ID
Path parameters
syllabusID (required)
Path Parameter x2014; Syllabus Identification
Return type
Example data
Content-Type: application/json
{ "owner" : "aeiou", "period" : "aeiou", "id" : "aeiou", "curriculumID" : "aeiou", "courseID" : "aeiou", "titleCode" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SyllabusResponse400
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 /{syllabusID}Modify Syllabus (modifySyllabus)
Modify syllabus
Path parameters
syllabusID (required)
Path Parameter x2014; Syllabus identification
Return type
Example data
Content-Type: application/json
{ "owner" : "aeiou", "period" : "aeiou", "curriculumID" : "aeiou", "courseID" : "aeiou", "titleCode" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SyllabusRequest400
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
Service Path:
/domains/legacy/syllabusbuilder/syllabus
Domain or University API:
D
